AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the RestoreSecret operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SecretsManager.AmazonSecretsManagerRequest
      Amazon.SecretsManager.Model.RestoreSecretRequest

Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

C#
public class RestoreSecretRequest : AmazonSecretsManagerRequest
         IAmazonWebServiceRequest

The RestoreSecretRequest type exposes the following members

Constructors

NameDescription
Public Method RestoreSecretRequest()

Properties

NameTypeDescription
Public Property SecretId System.String

Gets and sets the property SecretId.

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.

Examples

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

To restore a previously deleted secret


var client = new AmazonSecretsManagerClient();
var response = client.RestoreSecret(new RestoreSecretRequest 
{
    SecretId = "MyTestDatabaseSecret"
});

string arn = response.ARN;
string name = response.Name;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5