Interface DeleteSecretRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>,SdkBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>,SdkPojo,SdkRequest.Builder,SecretsManagerRequest.Builder
- Enclosing class:
- DeleteSecretRequest
public static interface DeleteSecretRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<DeleteSecretRequest.Builder,DeleteSecretRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DeleteSecretRequest.BuilderforceDeleteWithoutRecovery(Boolean forceDeleteWithoutRecovery)Specifies whether to delete the secret without any recovery window.DeleteSecretRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)DeleteSecretRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)DeleteSecretRequest.BuilderrecoveryWindowInDays(Long recoveryWindowInDays)The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret.DeleteSecretRequest.BuildersecretId(String secretId)The ARN or name of the secret to delete.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder
build
-
-
-
-
Method Detail
-
secretId
DeleteSecretRequest.Builder secretId(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
recoveryWindowInDays
DeleteSecretRequest.Builder recoveryWindowInDays(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
ForceDeleteWithoutRecoveryin the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.- Parameters:
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 andForceDeleteWithoutRecoveryin the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forceDeleteWithoutRecovery
DeleteSecretRequest.Builder forceDeleteWithoutRecovery(Boolean forceDeleteWithoutRecovery)
Specifies whether to delete the secret without any recovery window. You can't use both this parameter and
RecoveryWindowInDaysin 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
RecoveryWindowInDaysparameter. If you delete a secret with theForceDeleteWithoutRecoveryparameter, then you have no opportunity to recover the secret. You lose the secret permanently.- Parameters:
forceDeleteWithoutRecovery- Specifies whether to delete the secret without any recovery window. You can't use both this parameter andRecoveryWindowInDaysin 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
RecoveryWindowInDaysparameter. If you delete a secret with theForceDeleteWithoutRecoveryparameter, then you have no opportunity to recover the secret. You lose the secret permanently.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DeleteSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
DeleteSecretRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-