com.amazonaws.services.secretsmanager.model.DeleteSecretRequest 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 DeleteSecretRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the secret to delete. 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 the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
* You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.
*
*
* This value can range from 7 to 30 days with a default value of 30.
*
*/
private Long recoveryWindowInDays;
/**
*
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same name,
* ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
* permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you
* delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to
* recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
* the error ResourceNotFoundException in order to correctly handle retries.
*
*
*/
private Boolean forceDeleteWithoutRecovery;
/**
*
* Specifies the secret to delete. 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 to delete. 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 to delete. 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 to delete. 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 to delete. 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 to delete. 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 DeleteSecretRequest withSecretId(String secretId) {
setSecretId(secretId);
return this;
}
/**
*
* (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
* You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.
*
*
* This value can range from 7 to 30 days with a default value of 30.
*
*
* @param recoveryWindowInDays
* (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the
* secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the
* same API call.
*
* This value can range from 7 to 30 days with a default value of 30.
*/
public void setRecoveryWindowInDays(Long recoveryWindowInDays) {
this.recoveryWindowInDays = recoveryWindowInDays;
}
/**
*
* (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
* You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.
*
*
* This value can range from 7 to 30 days with a default value of 30.
*
*
* @return (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the
* secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in
* the same API call.
*
* This value can range from 7 to 30 days with a default value of 30.
*/
public Long getRecoveryWindowInDays() {
return this.recoveryWindowInDays;
}
/**
*
* (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
* You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.
*
*
* This value can range from 7 to 30 days with a default value of 30.
*
*
* @param recoveryWindowInDays
* (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the
* secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the
* same API call.
*
* This value can range from 7 to 30 days with a default value of 30.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteSecretRequest withRecoveryWindowInDays(Long recoveryWindowInDays) {
setRecoveryWindowInDays(recoveryWindowInDays);
return this;
}
/**
*
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same name,
* ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
* permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you
* delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to
* recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
* the error ResourceNotFoundException in order to correctly handle retries.
*
*
*
* @param forceDeleteWithoutRecovery
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same
* name, ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
* before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays
* parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have
* no opportunity to recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
* return the error ResourceNotFoundException in order to correctly handle retries.
*
*/
public void setForceDeleteWithoutRecovery(Boolean forceDeleteWithoutRecovery) {
this.forceDeleteWithoutRecovery = forceDeleteWithoutRecovery;
}
/**
*
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same name,
* ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
* permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you
* delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to
* recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
* the error ResourceNotFoundException in order to correctly handle retries.
*
*
*
* @return (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both
* this parameter and the RecoveryWindowInDays parameter in the same API call.
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same
* name, ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
* before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays
* parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you
* have no opportunity to recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
* return the error ResourceNotFoundException in order to correctly handle retries.
*
*/
public Boolean getForceDeleteWithoutRecovery() {
return this.forceDeleteWithoutRecovery;
}
/**
*
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same name,
* ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
* permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you
* delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to
* recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
* the error ResourceNotFoundException in order to correctly handle retries.
*
*
*
* @param forceDeleteWithoutRecovery
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same
* name, ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
* before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays
* parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have
* no opportunity to recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
* return the error ResourceNotFoundException in order to correctly handle retries.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteSecretRequest withForceDeleteWithoutRecovery(Boolean forceDeleteWithoutRecovery) {
setForceDeleteWithoutRecovery(forceDeleteWithoutRecovery);
return this;
}
/**
*
* (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
* parameter and the RecoveryWindowInDays parameter in the same API call.
*
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same name,
* ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
* permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you
* delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to
* recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
* the error ResourceNotFoundException in order to correctly handle retries.
*
*
*
* @return (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both
* this parameter and the RecoveryWindowInDays parameter in the same API call.
*
* An asynchronous background process performs the actual deletion, so there can be a short delay before the
* operation completes. If you write code to delete and then immediately recreate a secret with the same
* name, ensure that your code includes appropriate back off and retry logic.
*
*
*
* Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
* before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays
* parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you
* have no opportunity to recover the secret. You lose the secret permanently.
*
*
*
* If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
* return the error ResourceNotFoundException in order to correctly handle retries.
*
*/
public Boolean isForceDeleteWithoutRecovery() {
return this.forceDeleteWithoutRecovery;
}
/**
* 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 (getRecoveryWindowInDays() != null)
sb.append("RecoveryWindowInDays: ").append(getRecoveryWindowInDays()).append(",");
if (getForceDeleteWithoutRecovery() != null)
sb.append("ForceDeleteWithoutRecovery: ").append(getForceDeleteWithoutRecovery());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteSecretRequest == false)
return false;
DeleteSecretRequest other = (DeleteSecretRequest) obj;
if (other.getSecretId() == null ^ this.getSecretId() == null)
return false;
if (other.getSecretId() != null && other.getSecretId().equals(this.getSecretId()) == false)
return false;
if (other.getRecoveryWindowInDays() == null ^ this.getRecoveryWindowInDays() == null)
return false;
if (other.getRecoveryWindowInDays() != null && other.getRecoveryWindowInDays().equals(this.getRecoveryWindowInDays()) == false)
return false;
if (other.getForceDeleteWithoutRecovery() == null ^ this.getForceDeleteWithoutRecovery() == null)
return false;
if (other.getForceDeleteWithoutRecovery() != null && other.getForceDeleteWithoutRecovery().equals(this.getForceDeleteWithoutRecovery()) == 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 + ((getRecoveryWindowInDays() == null) ? 0 : getRecoveryWindowInDays().hashCode());
hashCode = prime * hashCode + ((getForceDeleteWithoutRecovery() == null) ? 0 : getForceDeleteWithoutRecovery().hashCode());
return hashCode;
}
@Override
public DeleteSecretRequest clone() {
return (DeleteSecretRequest) super.clone();
}
}