software.amazon.awssdk.services.secretsmanager.model

Interface RotateSecretRequest.Builder

All Superinterfaces:

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

Enclosing class:

RotateSecretRequest

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

Method Summary

Modifier and Type	Method and Description
RotateSecretRequest.Builder	clientRequestToken(String clientRequestToken) A unique identifier for the new version of the secret that helps ensure idempotency.
RotateSecretRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RotateSecretRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RotateSecretRequest.Builder	rotateImmediately(Boolean rotateImmediately) Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
RotateSecretRequest.Builder	rotationLambdaARN(String rotationLambdaARN) For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.
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) The ARN or name of the secret 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.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

RotateSecretRequest.Builder secretId(String secretId)

The ARN or name of the secret to rotate.

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

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

RotateSecretRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services 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 this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Parameters:

clientRequestToken - A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services 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 this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Returns:

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

rotationLambdaARN

RotateSecretRequest.Builder rotationLambdaARN(String rotationLambdaARN)

For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.

Parameters:

rotationLambdaARN - For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.

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 method 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)

rotateImmediately

RotateSecretRequest.Builder rotateImmediately(Boolean rotateImmediately)

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

By default, Secrets Manager rotates the secret immediately.

Parameters:

rotateImmediately - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

By default, Secrets Manager rotates the secret immediately.

Returns:

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

overrideConfiguration

RotateSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder