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.

This is the response object from the RotateSecret operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SecretsManager.Model.RotateSecretResponse

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

Syntax

C#
public class RotateSecretResponse : AmazonWebServiceResponse

The RotateSecretResponse type exposes the following members

Constructors

NameDescription
Public Method RotateSecretResponse()

Properties

NameTypeDescription
Public Property ARN System.String

Gets and sets the property ARN.

The ARN of the secret.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Name System.String

Gets and sets the property Name.

The name of the secret.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property VersionId System.String

Gets and sets the property VersionId.

The ID of the new version of the secret.

Examples

The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.

To configure rotation for a secret


var client = new AmazonSecretsManagerClient();
var response = client.RotateSecret(new RotateSecretRequest 
{
    RotationLambdaARN = "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
    RotationRules = new RotationRulesType {
        Duration = "2h",
        ScheduleExpression = "cron(0 16 1,15 * ? *)"
    },
    SecretId = "MyTestDatabaseSecret"
});

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

            

The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.

To request an immediate rotation for a secret


var client = new AmazonSecretsManagerClient();
var response = client.RotateSecret(new RotateSecretRequest 
{
    SecretId = "MyTestDatabaseSecret"
});

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

            

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