software.amazon.awssdk.services.secretsmanager.model

Interface GetSecretValueRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>, SdkBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>, SdkRequest.Builder, SecretsManagerRequest.Builder

Enclosing class:

GetSecretValueRequest

public static interface GetSecretValueRequest.Builder
extends SecretsManagerRequest.Builder, CopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>

Method Summary

Modifier and Type	Method and Description
GetSecretValueRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
GetSecretValueRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
GetSecretValueRequest.Builder	secretId(String secretId) Specifies the secret containing the version that you want to retrieve.
GetSecretValueRequest.Builder	versionId(String versionId) Specifies the unique identifier of the version of the secret that you want to retrieve.
GetSecretValueRequest.Builder	versionStage(String versionStage) Specifies the secret version that you want to retrieve by the staging label attached to the version.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

secretId

GetSecretValueRequest.Builder secretId(String secretId)

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.

Parameters:

secretId - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionId

GetSecretValueRequest.Builder versionId(String versionId)

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or SecretVersionId 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.

Parameters:

versionId - Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or SecretVersionId 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionStage

GetSecretValueRequest.Builder versionStage(String versionStage)

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 use this parameter then don't specify SecretVersionId. If you don't specify either a VersionStage or SecretVersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Parameters:

versionStage - 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 use this parameter then don't specify SecretVersionId. If you don't specify either a VersionStage or SecretVersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

GetSecretValueRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

GetSecretValueRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.