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:

SdkPojo, ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
String	secretId() Specifies the secret that you want to rotate.
static Class<? extends RotateSecretRequest.Builder>	serializableBuilderClass()
RotateSecretRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

secretId

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

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

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.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

clientRequestToken

public final String clientRequestToken()

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

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 your own value if you implement 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. This value becomes the VersionId 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 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 your own value if you implement 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. This value becomes the VersionId of the new version.

rotationLambdaARN

public final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

Specified by:

toBuilder in class SecretsManagerRequest

builder

public static RotateSecretRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo