software.amazon.awssdk.services.secretsmanager.model

Interface UpdateSecretRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateSecretRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateSecretRequest.Builder	clientRequestToken(String clientRequestToken) If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
UpdateSecretRequest.Builder	description(String description) The description of the secret.
UpdateSecretRequest.Builder	kmsKeyId(String kmsKeyId) The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS.
UpdateSecretRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateSecretRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateSecretRequest.Builder	secretBinary(SdkBytes secretBinary) The binary data to encrypt and store in the new version of the secret.
UpdateSecretRequest.Builder	secretId(String secretId) The ARN or name of the secret.
UpdateSecretRequest.Builder	secretString(String secretString) The text data to encrypt and store in the new 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

UpdateSecretRequest.Builder secretId(String secretId)

The ARN or name of the secret.

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.

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.

clientRequestToken

UpdateSecretRequest.Builder clientRequestToken(String clientRequestToken)

If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.

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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. 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 the new version and include the value in the request.

This value becomes the VersionId of the new version.

Parameters:

clientRequestToken - If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.

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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. 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 the new version and include the value in the request.

This value becomes the VersionId of the new version.

Returns:

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

description

UpdateSecretRequest.Builder description(String description)

The description of the secret.

Parameters:

description - The description of the secret.

Returns:

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

kmsKeyId

UpdateSecretRequest.Builder kmsKeyId(String kmsKeyId)

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version.

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.

Parameters:

kmsKeyId - The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version.

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.

Returns:

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

secretBinary

UpdateSecretRequest.Builder secretBinary(SdkBytes secretBinary)

The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

Either SecretBinary or SecretString must have a value, but not both.

You can't access this parameter in the Secrets Manager console.

Parameters:

secretBinary - The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

Either SecretBinary or SecretString must have a value, but not both.

You can't access this parameter in the Secrets Manager console.

Returns:

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

secretString

UpdateSecretRequest.Builder secretString(String secretString)

The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

Either SecretBinary or SecretString must have a value, but not both.

Parameters:

secretString - The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

Either SecretBinary or SecretString must have a value, but not both.

Returns:

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

overrideConfiguration

UpdateSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder