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

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

Overview

Note:

When making an API call, you may pass DeleteSecretRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  recovery_window_in_days: 1,
  force_delete_without_recovery: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#force_delete_without_recoveryBoolean

(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 Amazon Web Services 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. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error `ResourceNotFoundException` in order to correctly handle retries.

Returns:

  • (Boolean)

440
441
442
443
444
445
446
# File 'lib/aws-sdk-secretsmanager/types.rb', line 440

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

#recovery_window_in_daysInteger

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager 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 with a default value of 30.

Returns:

  • (Integer)

440
441
442
443
444
445
446
# File 'lib/aws-sdk-secretsmanager/types.rb', line 440

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

#secret_idString

Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Returns:

  • (String)

440
441
442
443
444
445
446
# File 'lib/aws-sdk-secretsmanager/types.rb', line 440

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