Package software.amazon.awssdk.services.secretsmanager.model

Interface GetSecretValueRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetSecretValueRequest

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

Method Summary

Modifier and Type	Method	Description
GetSecretValueRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetSecretValueRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetSecretValueRequest.Builder	secretId(String secretId)	The ARN or name of the secret to retrieve.
GetSecretValueRequest.Builder	versionId(String versionId)	The unique identifier of the version of the secret to retrieve.
GetSecretValueRequest.Builder	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 Detail

secretId

GetSecretValueRequest.Builder secretId(String 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

GetSecretValueRequest.Builder versionId(String 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 a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT 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 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.

Returns:

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

versionStage

GetSecretValueRequest.Builder versionStage(String 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 a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT 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 a VersionStage or VersionId , Secrets Manager returns the AWSCURRENT version.

Returns:

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

overrideConfiguration

GetSecretValueRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetSecretValueRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder