software.amazon.awssdk.services.secretsmanager.model

Interface RotateSecretRequest.Builder

All Superinterfaces:

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

Enclosing class:

RotateSecretRequest

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

Method Summary

Modifier and Type	Method and Description
RotateSecretRequest.Builder	clientRequestToken(String clientRequestToken) (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
RotateSecretRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
RotateSecretRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
RotateSecretRequest.Builder	rotationLambdaARN(String rotationLambdaARN) (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
default RotateSecretRequest.Builder	rotationRules(Consumer<RotationRulesType.Builder> rotationRules) A structure that defines the rotation configuration for this secret.
RotateSecretRequest.Builder	rotationRules(RotationRulesType rotationRules) A structure that defines the rotation configuration for this secret.
RotateSecretRequest.Builder	secretId(String secretId) Specifies the secret that you want to rotate.

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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Method Detail

secretId

RotateSecretRequest.Builder secretId(String secretId)

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Parameters:

secretId - Specifies the secret that you want to rotate. 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.

clientRequestToken

RotateSecretRequest.Builder clientRequestToken(String clientRequestToken)

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. 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.

You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing.

• 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 and SecretBinary values are the same as the request, then the request is ignored (the operation is idempotent).

• If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.

This value becomes the SecretVersionId of the new version.

Parameters:

clientRequestToken - (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. 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.

You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing.

• 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 and SecretBinary values are the same as the request, then the request is ignored (the operation is idempotent).

• If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.

This value becomes the SecretVersionId of the new version.

Returns:

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

rotationLambdaARN

RotateSecretRequest.Builder rotationLambdaARN(String rotationLambdaARN)

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Parameters:

rotationLambdaARN - (Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Returns:

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

rotationRules

RotateSecretRequest.Builder rotationRules(RotationRulesType rotationRules)

A structure that defines the rotation configuration for this secret.

Parameters:

rotationRules - A structure that defines the rotation configuration for this secret.

Returns:

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

rotationRules

default RotateSecretRequest.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)

A structure that defines the rotation configuration for this secret.

This is a convenience that creates an instance of the RotationRulesType.Builder avoiding the need to create one manually via RotationRulesType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rotationRules(RotationRulesType).

Parameters:

rotationRules - a consumer that will call methods on RotationRulesType.Builder

Returns:

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

See Also:

rotationRules(RotationRulesType)

overrideConfiguration

RotateSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.