public static interface DeleteSecretRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>
| Modifier and Type | Method and Description |
|---|---|
DeleteSecretRequest.Builder |
forceDeleteWithoutRecovery(Boolean forceDeleteWithoutRecovery)
(Optional) Specifies that the secret is to be deleted without any recovery window.
|
DeleteSecretRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
DeleteSecretRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
DeleteSecretRequest.Builder |
recoveryWindowInDays(Long recoveryWindowInDays)
(Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret.
|
DeleteSecretRequest.Builder |
secretId(String secretId)
Specifies the secret that you want to delete.
|
buildoverrideConfigurationcopyapplyMutation, buildDeleteSecretRequest.Builder secretId(String secretId)
Specifies the secret that you want 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 that end with a hyphen followed by six characters.
secretId - Specifies the secret that you want 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 that end with a hyphen followed by six characters.
DeleteSecretRequest.Builder recoveryWindowInDays(Long recoveryWindowInDays)
(Optional) Specifies the number of days that Secrets Manager waits before it 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. The default value is 30.
recoveryWindowInDays - (Optional) Specifies the number of days that Secrets Manager waits before it 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. The default value is 30.
DeleteSecretRequest.Builder forceDeleteWithoutRecovery(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. It is permanently lost.
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.
It is permanently lost.
DeleteSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.DeleteSecretRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.