Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . secretsmanager ]

restore-secret

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:

  • secretsmanager:RestoreSecret
Related operations
  • To delete a secret, use delete-secret .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  restore-secret
--secret-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--secret-id (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To restore a previously deleted secret

The following example shows how to restore a secret that you previously scheduled for deletion.

aws secretsmanager restore-secret --secret-id MyTestDatabaseSecret

The output shows the following:

{
  "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
  "Name": "MyTestDatabaseSecret"
}

Output

ARN -> (string)

The ARN of the secret that was restored.

Name -> (string)

The friendly name of the secret that was restored.