@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) |
Boolean |
forceDeleteWithoutRecovery()
Specifies whether to delete the secret without any recovery window.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Long |
recoveryWindowInDays()
The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret.
|
List<SdkField<?>> |
sdkFields() |
String |
secretId()
The ARN or name of the secret to delete.
|
static Class<? extends DeleteSecretRequest.Builder> |
serializableBuilderClass() |
DeleteSecretRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String secretId()
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
public final Long recoveryWindowInDays()
The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can't use
both this parameter and ForceDeleteWithoutRecovery in the same call. If you don't use either, then
by default Secrets Manager uses a 30 day recovery window.
ForceDeleteWithoutRecovery in the same call. If you don't
use either, then by default Secrets Manager uses a 30 day recovery window.public final Boolean forceDeleteWithoutRecovery()
Specifies whether to delete the secret without any recovery window. You can't use both this parameter and
RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets Manager uses
a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the operation does not return
ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before
the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no
opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets
Manager uses a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the operation does not return
ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window
before the permanent deletion that Secrets Manager would normally impose with the
RecoveryWindowInDays parameter. If you delete a secret with the
ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret.
You lose the secret permanently.
public DeleteSecretRequest.Builder toBuilder()
toBuilder 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)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.