com.amazonaws.services.secretsmanager.model

Class RotateSecretRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.secretsmanager.model.RotateSecretRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RotateSecretRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RotateSecretRequest()

Method Summary

Modifier and Type	Method and Description
RotateSecretRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
String	getRotationLambdaARN() (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
RotationRulesType	getRotationRules() A structure that defines the rotation configuration for this secret.
String	getSecretId() Specifies the secret that you want to rotate.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
void	setRotationLambdaARN(String rotationLambdaARN) (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
void	setRotationRules(RotationRulesType rotationRules) A structure that defines the rotation configuration for this secret.
void	setSecretId(String secretId) Specifies the secret that you want to rotate.
String	toString() Returns a string representation of this object.
RotateSecretRequest	withClientRequestToken(String clientRequestToken) (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
RotateSecretRequest	withRotationLambdaARN(String rotationLambdaARN) (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
RotateSecretRequest	withRotationRules(RotationRulesType rotationRules) A structure that defines the rotation configuration for this secret.
RotateSecretRequest	withSecretId(String secretId) Specifies the secret that you want to rotate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RotateSecretRequest

public RotateSecretRequest()

Method Detail

setSecretId

public void setSecretId(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.

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.

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

getSecretId

public String getSecretId()

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.

withSecretId

public RotateSecretRequest withSecretId(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.

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.

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

Returns:

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

setClientRequestToken

public void setClientRequestToken(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.

Parameters:

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.

getClientRequestToken

public String getClientRequestToken()

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

withClientRequestToken

public RotateSecretRequest withClientRequestToken(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.

Parameters:

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:

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

setRotationLambdaARN

public void setRotationLambdaARN(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.

getRotationLambdaARN

public String getRotationLambdaARN()

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

withRotationLambdaARN

public RotateSecretRequest withRotationLambdaARN(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.

setRotationRules

public void setRotationRules(RotationRulesType rotationRules)

A structure that defines the rotation configuration for this secret.

Parameters:

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

getRotationRules

public RotationRulesType getRotationRules()

A structure that defines the rotation configuration for this secret.

Returns:

A structure that defines the rotation configuration for this secret.

withRotationRules

public RotateSecretRequest withRotationRules(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RotateSecretRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()