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)

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

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. If you don't specify which version in `VersionId` or `VersionStage`, then Secrets Manager uses the `AWSCURRENT` version.

Returns:

  • (Time)

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

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)

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

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 secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a [base64-encoded] string.

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.

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

Returns:

  • (String)

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

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 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)

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

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)

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

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>)

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

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