Class DeleteSecretRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DeleteSecretRequest.Builder,
DeleteSecretRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DeleteSecretRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Specifies whether to delete the secret without any recovery window.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Long
The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret.final String
secretId()
The ARN or name of the secret to delete.static Class
<? extends DeleteSecretRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
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.- Returns:
- 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
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 theForceDeleteWithoutRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.- Returns:
- 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 theForceDeleteWithoutRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DeleteSecretRequest.Builder,
DeleteSecretRequest> - Specified by:
toBuilder
in classSecretsManagerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-