@Generated(value="software.amazon.awssdk:codegen") public final class DeleteSecretRequest extends SecretsManagerRequest implements ToCopyableBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DeleteSecretRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DeleteSecretRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Boolean |
forceDeleteWithoutRecovery()
(Optional) Specifies that the secret is to be deleted without any recovery window.
|
<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() |
Long |
recoveryWindowInDays()
(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
|
List<SdkField<?>> |
sdkFields() |
String |
secretId()
Specifies the secret to delete.
|
static Class<? extends DeleteSecretRequest.Builder> |
serializableBuilderClass() |
DeleteSecretRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String 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.
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 final Long 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.
ForceDeleteWithoutRecovery parameter in
the same API call.
This value can range from 7 to 30 days with a default value of 30.
public final Boolean 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.
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 DeleteSecretRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>toBuilder in class SecretsManagerRequestpublic static DeleteSecretRequest.Builder builder()
public static Class<? extends DeleteSecretRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.