Class: Aws::SecretsManager::Types::GetSecretValueRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecretsManager::Types::GetSecretValueRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-secretsmanager/types.rb
Overview
When making an API call, you may pass GetSecretValueRequest data as a hash:
{
secret_id: "SecretIdType", # required
version_id: "SecretVersionIdType",
version_stage: "SecretVersionStageType",
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#secret_id ⇒ String
Specifies the secret containing the version that you want to retrieve.
-
#version_id ⇒ String
Specifies the unique identifier of the version of the secret that you want to retrieve.
-
#version_stage ⇒ String
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Instance Attribute Details
#secret_id ⇒ String
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
880 881 882 883 884 885 886 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 880 class GetSecretValueRequest < Struct.new( :secret_id, :version_id, :version_stage) SENSITIVE = [] include Aws::Structure end |
#version_id ⇒ String
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify 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 the default is to perform the operation on the version with the `VersionStage` value of `AWSCURRENT`.
This value is typically a [UUID-type] value with 32 hexadecimal digits.
880 881 882 883 884 885 886 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 880 class GetSecretValueRequest < Struct.new( :secret_id, :version_id, :version_stage) SENSITIVE = [] include Aws::Structure end |
#version_stage ⇒ String
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify 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`, then the default is to perform the operation on the version with the `VersionStage` value of `AWSCURRENT`.
880 881 882 883 884 885 886 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 880 class GetSecretValueRequest < Struct.new( :secret_id, :version_id, :version_stage) SENSITIVE = [] include Aws::Structure end |