Class: Aws::SecretsManager::Types::DeleteSecretRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#force_delete_without_recovery ⇒ Boolean

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.

Returns:

  • (Boolean) 


456
457
458
459
460
461
462
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 456

class DeleteSecretRequest < Struct.new(
  :secret_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_window_in_days ⇒ Integer

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:

  • (Integer) 


456
457
458
459
460
461
462
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 456

class DeleteSecretRequest < Struct.new(
  :secret_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end

#secret_id ⇒ String

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].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

  • (String) 


456
457
458
459
460
461
462
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 456

class DeleteSecretRequest < Struct.new(
  :secret_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end