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

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

Overview

Constant Summary collapse

SENSITIVE =
[:secret_binary, :secret_string]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the secret.

Returns:

  • (String)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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_dateTime

The date and time that this version of the secret was created.

Returns:

  • (Time)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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

#nameString

The friendly name of the secret.

Returns:

  • (String)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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_binaryString

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.

[1]: tools.ietf.org/html/rfc4648#section-4

Returns:

  • (String)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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_stringString

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.

Returns:

  • (String)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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_idString

The unique identifier of this version of the secret.

Returns:

  • (String)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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_stagesArray<String>

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

Returns:

  • (Array<String>)

945
946
947
948
949
950
951
952
953
954
955
# File 'lib/aws-sdk-secretsmanager/types.rb', line 945

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