Class: Aws::SecretsManager::Types::GetSecretValueResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecretsManager::Types::GetSecretValueResponse
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-secretsmanager/types.rb
Overview
Instance Attribute Summary collapse
-
#arn ⇒ String
The ARN of the secret.
-
#created_date ⇒ Time
The date and time that this version of the secret was created.
-
#name ⇒ String
The friendly name of the secret.
-
#secret_binary ⇒ String
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
-
#secret_string ⇒ String
The decrypted part of the protected secret information that was originally provided as a string.
-
#version_id ⇒ String
The unique identifier of this version of the secret.
-
#version_stages ⇒ Array<String>
A list of all of the staging labels currently attached to this version of the secret.
Instance Attribute Details
#arn ⇒ String
The ARN of the secret.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#created_date ⇒ Time
The date and time that this version of the secret was created.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#name ⇒ String
The friendly name of the secret.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#secret_binary ⇒ String
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a
- base64-encoded][1
-
string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the ‘SecretString` or `SecretBinary` fields.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#secret_string ⇒ String
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the ‘SecretString` parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the **Other secret type** in the console, then you must code your Lambda rotation function to parse and interpret those values.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#version_id ⇒ String
The unique identifier of this version of the secret.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |
#version_stages ⇒ Array<String>
A list of all of the staging labels currently attached to this version of the secret.
924 925 926 927 928 929 930 931 932 933 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 924 class GetSecretValueResponse < Struct.new( :arn, :name, :version_id, :secret_binary, :secret_string, :version_stages, :created_date) include Aws::Structure end |