Class: Aws::SecretsManager::Types::GetSecretValueResponse

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:secret_binary, :secret_string]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the secret.

Returns:

  • (String) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#created_date ⇒ Time

The date and time that this version of the secret was created. If you don’t specify which version in ‘VersionId` or `VersionStage`, then Secrets Manager uses the `AWSCURRENT` version.

Returns:

  • (Time) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#name ⇒ String

The friendly name of the secret.

Returns:

  • (String) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#secret_binary ⇒ String

The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a ‘SecretBinary` using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.

If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in ‘SecretString` instead.

Returns:

  • (String) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#secret_string ⇒ String

The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.

Returns:

  • (String) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#version_id ⇒ String

The unique identifier of this version of the secret.

Returns:

  • (String) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end

#version_stages ⇒ Array<String>

A list of all of the staging labels currently attached to this version of the secret.

Returns:

  • (Array<String>) 


956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 956

class GetSecretValueResponse < Struct.new(
  :arn,
  :name,
  :version_id,
  :secret_binary,
  :secret_string,
  :version_stages,
  :created_date)
  SENSITIVE = [:secret_binary, :secret_string]
  include Aws::Structure
end