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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-secretsmanager/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

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 Secrets Manager defaults to 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.

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 ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

Returns:

  • (Boolean)


420
421
422
423
424
425
426
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 420

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

#recovery_window_in_daysInteger

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 Secrets Manager defaults to a 30 day recovery window.

Returns:

  • (Integer)


420
421
422
423
424
425
426
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 420

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

#secret_idString

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:

  • (String)


420
421
422
423
424
425
426
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 420

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