Amazonka.SecretsManager.DeleteSecret

Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.

You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.

At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data DeleteSecret

See: newDeleteSecret smart constructor.

Constructors

DeleteSecret'

Fields

• forceDeleteWithoutRecovery :: Maybe Bool

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

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

• secretId :: Text

  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.

Instances

ToJSON DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

toJSON :: DeleteSecret -> Value

toEncoding :: DeleteSecret -> Encoding

toJSONList :: [DeleteSecret] -> Value

toEncodingList :: [DeleteSecret] -> Encoding

ToHeaders DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

toHeaders :: DeleteSecret -> [Header]

ToPath DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

toPath :: DeleteSecret -> ByteString

ToQuery DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

toQuery :: DeleteSecret -> QueryString

AWSRequest DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type AWSResponse DeleteSecret

Methods

request :: (Service -> Service) -> DeleteSecret -> Request DeleteSecret

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteSecret -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteSecret)))

Generic DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecret :: Type -> Type

Methods

from :: DeleteSecret -> Rep DeleteSecret x

to :: Rep DeleteSecret x -> DeleteSecret

Read DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

readsPrec :: Int -> ReadS DeleteSecret

readList :: ReadS [DeleteSecret]

readPrec :: ReadPrec DeleteSecret

readListPrec :: ReadPrec [DeleteSecret]

Show DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

showsPrec :: Int -> DeleteSecret -> ShowS

show :: DeleteSecret -> String

showList :: [DeleteSecret] -> ShowS

NFData DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecret -> ()

Eq DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

(==) :: DeleteSecret -> DeleteSecret -> Bool

(/=) :: DeleteSecret -> DeleteSecret -> Bool

Hashable DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

hashWithSalt :: Int -> DeleteSecret -> Int

hash :: DeleteSecret -> Int

type AWSResponse DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

type AWSResponse DeleteSecret = DeleteSecretResponse

type Rep DeleteSecret

Defined in Amazonka.SecretsManager.DeleteSecret

type Rep DeleteSecret = D1 ('MetaData "DeleteSecret" "Amazonka.SecretsManager.DeleteSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "DeleteSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceDeleteWithoutRecovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "recoveryWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteSecret

Arguments

:: Text

$sel:secretId:DeleteSecret'

-> DeleteSecret

Create a value of DeleteSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forceDeleteWithoutRecovery:DeleteSecret', deleteSecret_forceDeleteWithoutRecovery - 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 ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

$sel:recoveryWindowInDays:DeleteSecret', deleteSecret_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 ForceDeleteWithoutRecovery in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

$sel:secretId:DeleteSecret', deleteSecret_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.

Request Lenses

deleteSecret_forceDeleteWithoutRecovery :: Lens' DeleteSecret (Maybe Bool)

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

deleteSecret_recoveryWindowInDays :: Lens' DeleteSecret (Maybe 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 Secrets Manager defaults to a 30 day recovery window.

deleteSecret_secretId :: Lens' DeleteSecret Text

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.

Destructuring the Response

data DeleteSecretResponse

See: newDeleteSecretResponse smart constructor.

Constructors

DeleteSecretResponse'

Fields

• arn :: Maybe Text

  The ARN of the secret.

• deletionDate :: Maybe POSIX

  The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.

• name :: Maybe Text

  The name of the secret.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecretResponse :: Type -> Type

Methods

from :: DeleteSecretResponse -> Rep DeleteSecretResponse x

to :: Rep DeleteSecretResponse x -> DeleteSecretResponse

Read DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

readsPrec :: Int -> ReadS DeleteSecretResponse

readList :: ReadS [DeleteSecretResponse]

readPrec :: ReadPrec DeleteSecretResponse

readListPrec :: ReadPrec [DeleteSecretResponse]

Show DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

showsPrec :: Int -> DeleteSecretResponse -> ShowS

show :: DeleteSecretResponse -> String

showList :: [DeleteSecretResponse] -> ShowS

NFData DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecretResponse -> ()

Eq DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

Methods

(==) :: DeleteSecretResponse -> DeleteSecretResponse -> Bool

(/=) :: DeleteSecretResponse -> DeleteSecretResponse -> Bool

type Rep DeleteSecretResponse

Defined in Amazonka.SecretsManager.DeleteSecret

type Rep DeleteSecretResponse = D1 ('MetaData "DeleteSecretResponse" "Amazonka.SecretsManager.DeleteSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "DeleteSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteSecretResponse

Arguments

:: Int

$sel:httpStatus:DeleteSecretResponse'

-> DeleteSecretResponse

Create a value of DeleteSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteSecretResponse, deleteSecretResponse_arn - The ARN of the secret.

$sel:deletionDate:DeleteSecretResponse', deleteSecretResponse_deletionDate - The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.

DeleteSecretResponse, deleteSecretResponse_name - The name of the secret.

$sel:httpStatus:DeleteSecretResponse', deleteSecretResponse_httpStatus - The response's http status code.

Response Lenses

deleteSecretResponse_arn :: Lens' DeleteSecretResponse (Maybe Text)

The ARN of the secret.

deleteSecretResponse_deletionDate :: Lens' DeleteSecretResponse (Maybe UTCTime)

The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.

deleteSecretResponse_name :: Lens' DeleteSecretResponse (Maybe Text)

The name of the secret.

deleteSecretResponse_httpStatus :: Lens' DeleteSecretResponse Int

The response's http status code.