com.amazonaws.services.secretsmanager.model.RotateSecretRequest Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.secretsmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RotateSecretRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*/
private String secretId;
/**
*
* (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 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.
*
*/
private String clientRequestToken;
/**
*
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*
*/
private String rotationLambdaARN;
/**
*
* A structure that defines the rotation configuration for this secret.
*
*/
private RotationRulesType rotationRules;
/**
*
* 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @param 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
*/
public void setSecretId(String secretId) {
this.secretId = 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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @return 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
*/
public String getSecretId() {
return this.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 ending with a hyphen
* followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager, you
* receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your
* permissions.
*
*
*
* @param 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 ending with a hyphen followed by six characters.
*
*
* If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you
* must not include the random suffix. If you do include the random suffix added by Secrets Manager,
* you receive either a ResourceNotFoundException or an AccessDeniedException error, depending
* on your permissions.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RotateSecretRequest withSecretId(String secretId) {
setSecretId(secretId);
return this;
}
/**
*
* (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 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.
*
*
* @param 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 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.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = 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 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.
*
*
* @return (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 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.
*/
public String getClientRequestToken() {
return this.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 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.
*
*
* @param 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 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RotateSecretRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*
*
* @param rotationLambdaARN
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*/
public void setRotationLambdaARN(String rotationLambdaARN) {
this.rotationLambdaARN = rotationLambdaARN;
}
/**
*
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*
*
* @return (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*/
public String getRotationLambdaARN() {
return this.rotationLambdaARN;
}
/**
*
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
*
*
* @param rotationLambdaARN
* (Optional) Specifies the ARN of the Lambda function that can rotate the secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RotateSecretRequest withRotationLambdaARN(String rotationLambdaARN) {
setRotationLambdaARN(rotationLambdaARN);
return this;
}
/**
*
* A structure that defines the rotation configuration for this secret.
*
*
* @param rotationRules
* A structure that defines the rotation configuration for this secret.
*/
public void setRotationRules(RotationRulesType rotationRules) {
this.rotationRules = rotationRules;
}
/**
*
* A structure that defines the rotation configuration for this secret.
*
*
* @return A structure that defines the rotation configuration for this secret.
*/
public RotationRulesType getRotationRules() {
return this.rotationRules;
}
/**
*
* A structure that defines the rotation configuration for this secret.
*
*
* @param rotationRules
* A structure that defines the rotation configuration for this secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RotateSecretRequest withRotationRules(RotationRulesType rotationRules) {
setRotationRules(rotationRules);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSecretId() != null)
sb.append("SecretId: ").append(getSecretId()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getRotationLambdaARN() != null)
sb.append("RotationLambdaARN: ").append(getRotationLambdaARN()).append(",");
if (getRotationRules() != null)
sb.append("RotationRules: ").append(getRotationRules());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RotateSecretRequest == false)
return false;
RotateSecretRequest other = (RotateSecretRequest) obj;
if (other.getSecretId() == null ^ this.getSecretId() == null)
return false;
if (other.getSecretId() != null && other.getSecretId().equals(this.getSecretId()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getRotationLambdaARN() == null ^ this.getRotationLambdaARN() == null)
return false;
if (other.getRotationLambdaARN() != null && other.getRotationLambdaARN().equals(this.getRotationLambdaARN()) == false)
return false;
if (other.getRotationRules() == null ^ this.getRotationRules() == null)
return false;
if (other.getRotationRules() != null && other.getRotationRules().equals(this.getRotationRules()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecretId() == null) ? 0 : getSecretId().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getRotationLambdaARN() == null) ? 0 : getRotationLambdaARN().hashCode());
hashCode = prime * hashCode + ((getRotationRules() == null) ? 0 : getRotationRules().hashCode());
return hashCode;
}
@Override
public RotateSecretRequest clone() {
return (RotateSecretRequest) super.clone();
}
}