Restore Secret

secretsmanager_restore_secret

R Documentation

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp¶

Description¶

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

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:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Usage¶

secretsmanager_restore_secret(SecretId)

Arguments¶

SecretId

[required] The ARN or name of the secret to restore.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Value¶

A list with the following syntax:

list(
  ARN = "string",
  Name = "string"
)

Request syntax¶

svc$restore_secret(
  SecretId = "string"
)

Examples¶

## Not run: 
# The following example shows how to restore a secret that you previously
# scheduled for deletion.
svc$restore_secret(
  SecretId = "MyTestDatabaseSecret"
)

## End(Not run)