software.amazon.awssdk.services.secretsmanager.model

Interface PutSecretValueRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutSecretValueRequest

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

Method Summary

Modifier and Type	Method and Description
PutSecretValueRequest.Builder	clientRequestToken(String clientRequestToken) A unique identifier for the new version of the secret.
PutSecretValueRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutSecretValueRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutSecretValueRequest.Builder	secretBinary(SdkBytes secretBinary) The binary data to encrypt and store in the new version of the secret.
PutSecretValueRequest.Builder	secretId(String secretId) The ARN or name of the secret to add a new version to.
PutSecretValueRequest.Builder	secretString(String secretString) The text to encrypt and store in the new version of the secret.
PutSecretValueRequest.Builder	versionStages(Collection<String> versionStages) A list of staging labels to attach to this version of the secret.
PutSecretValueRequest.Builder	versionStages(String... versionStages) A list of staging labels to attach to this version of the secret.

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

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

secretId

PutSecretValueRequest.Builder secretId(String secretId)

The ARN or name of the secret to add a new version to.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

If the secret doesn't already exist, use CreateSecret instead.

Parameters:

secretId - The ARN or name of the secret to add a new version to.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

If the secret doesn't already exist, use CreateSecret instead.

Returns:

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

clientRequestToken

PutSecretValueRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

• If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

• If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.

• If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Parameters:

clientRequestToken - A unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

• If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

• If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.

• If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

Returns:

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

secretBinary

PutSecretValueRequest.Builder secretBinary(SdkBytes secretBinary)

The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

You must include SecretBinary or SecretString, but not both.

You can't access this value from the Secrets Manager console.

Parameters:

secretBinary - The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

You must include SecretBinary or SecretString, but not both.

You can't access this value from the Secrets Manager console.

Returns:

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

secretString

PutSecretValueRequest.Builder secretString(String secretString)

The text to encrypt and store in the new version of the secret.

You must include SecretBinary or SecretString, but not both.

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

Parameters:

secretString - The text to encrypt and store in the new version of the secret.

You must include SecretBinary or SecretString, but not both.

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

Returns:

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

versionStages

PutSecretValueRequest.Builder versionStages(Collection<String> versionStages)

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Parameters:

versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Returns:

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

versionStages

PutSecretValueRequest.Builder versionStages(String... versionStages)

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Parameters:

versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Returns:

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

overrideConfiguration

PutSecretValueRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder