software.amazon.awssdk.services.secretsmanager.model

Class RotateSecretRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest

software.amazon.awssdk.services.secretsmanager.model.RotateSecretRequest

All Implemented Interfaces:

ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class RotateSecretRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RotateSecretRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RotateSecretRequest.Builder	builder()
String	clientRequestToken() (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	rotationLambdaARN() (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
RotationRulesType	rotationRules() A structure that defines the rotation configuration for this secret.
String	secretId() Specifies the secret that you want to rotate.
static Class<? extends RotateSecretRequest.Builder>	serializableBuilderClass()
RotateSecretRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

secretId

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

Returns:

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

clientRequestToken

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

Returns:

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

rotationLambdaARN

public String rotationLambdaARN()

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

Returns:

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

rotationRules

public RotationRulesType rotationRules()

A structure that defines the rotation configuration for this secret.

Returns:

A structure that defines the rotation configuration for this secret.

toBuilder

public RotateSecretRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

Specified by:

toBuilder in class SecretsManagerRequest

Returns:

a builder for type T

builder

public static RotateSecretRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RotateSecretRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value