secretsmanager_restore_secret: Cancels the scheduled deletion of a secret by removing the...

Description Usage Arguments Value Request syntax Examples

View source: R/secretsmanager_operations.R

Description

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

Minimum permissions

To run this command, you must have the following permissions:

Related operations

Usage

1

Arguments

SecretId

[required] Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Value

A list with the following syntax:

1
2
3
4
list(
  ARN = "string",
  Name = "string"
)

Request syntax

1
2
3
svc$restore_secret(
  SecretId = "string"
)

Examples

1
2
3
4
5
6
7
8
## 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)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.