@Generated(value="software.amazon.awssdk:codegen") public final class RotateSecretRequest extends SecretsManagerRequest implements ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RotateSecretRequest.Builder |
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.
|
List<SdkField<?>> |
sdkFields() |
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() |
overrideConfiguration
copy
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.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
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. This value becomes the VersionId
of the new version.
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. This value becomes the VersionId
of
the new version.
public String rotationLambdaARN()
(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
public RotationRulesType rotationRules()
A structure that defines the rotation configuration for this secret.
public RotateSecretRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>
toBuilder
in class SecretsManagerRequest
public static RotateSecretRequest.Builder builder()
public static Class<? extends RotateSecretRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.