Interface GetSecretValueRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetSecretValueRequest.Builder,
,GetSecretValueRequest> SdkBuilder<GetSecretValueRequest.Builder,
,GetSecretValueRequest> SdkPojo
,SdkRequest.Builder
,SecretsManagerRequest.Builder
- Enclosing class:
GetSecretValueRequest
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ARN or name of the secret to retrieve.The unique identifier of the version of the secret to retrieve.versionStage
(String versionStage) The staging label of the version of the secret to retrieve.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder
build
-
Method Details
-
secretId
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. See Finding a secret from a partial ARN.
- Parameters:
secretId
- 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. See Finding a secret from a partial ARN.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
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 aVersionStage
orVersionId
, then Secrets Manager returns theAWSCURRENT
version.This value is typically a UUID-type value with 32 hexadecimal digits.
- Parameters:
versionId
- The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either aVersionStage
orVersionId
, then Secrets Manager returns theAWSCURRENT
version.This value is typically a UUID-type value with 32 hexadecimal digits.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionStage
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 aVersionStage
orVersionId
, Secrets Manager returns theAWSCURRENT
version.- Parameters:
versionStage
- 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 aVersionStage
orVersionId
, Secrets Manager returns theAWSCURRENT
version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetSecretValueRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetSecretValueRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-