Class: Aws::SecretsManager::Types::GetSecretValueRequest

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

Overview

Note:

When making an API call, you may pass GetSecretValueRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  version_id: "SecretVersionIdType",
  version_stage: "SecretVersionStageType",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#secret_id ⇒ String

The ARN or name of the secret to retrieve.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Returns:

  • (String) 


863
864
865
866
867
868
869
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 863

class GetSecretValueRequest < Struct.new(
  :secret_id,
  :version_id,
  :version_stage)
  SENSITIVE = []
  include Aws::Structure
end

#version_id ⇒ String

The unique identifier of the version of the secret to retrieve. If you include both this parameter and ‘VersionStage`, the two parameters must refer to the same secret version. If you don’t specify either a ‘VersionStage` or `VersionId`, then Secrets Manager returns the `AWSCURRENT` version.

This value is typically a [UUID-type] value with 32 hexadecimal digits.

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

  • (String) 


863
864
865
866
867
868
869
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 863

class GetSecretValueRequest < Struct.new(
  :secret_id,
  :version_id,
  :version_stage)
  SENSITIVE = []
  include Aws::Structure
end

#version_stage ⇒ String

The staging label of the version of the secret to retrieve.

Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and ‘VersionId`, the two parameters must refer to the same secret version. If you don’t specify either a ‘VersionStage` or `VersionId`, Secrets Manager returns the `AWSCURRENT` version.

Returns:

  • (String) 


863
864
865
866
867
868
869
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 863

class GetSecretValueRequest < Struct.new(
  :secret_id,
  :version_id,
  :version_stage)
  SENSITIVE = []
  include Aws::Structure
end