Class CfnRotationSchedule

Namespace

Amazon.CDK.AWS.SecretsManager

Assembly

Amazon.CDK.AWS.SecretsManager.dll

A CloudFormation AWS::SecretsManager::RotationSchedule.

public class CfnRotationSchedule : CfnResource, IInspectable

Inheritance

object

CfnRotationSchedule

Implements

IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SecretsManager;

             var cfnRotationSchedule = new CfnRotationSchedule(this, "MyCfnRotationSchedule", new CfnRotationScheduleProps {
                 SecretId = "secretId",

                 // the properties below are optional
                 HostedRotationLambda = new HostedRotationLambdaProperty {
                     RotationType = "rotationType",

                     // the properties below are optional
                     ExcludeCharacters = "excludeCharacters",
                     KmsKeyArn = "kmsKeyArn",
                     MasterSecretArn = "masterSecretArn",
                     MasterSecretKmsKeyArn = "masterSecretKmsKeyArn",
                     RotationLambdaName = "rotationLambdaName",
                     Runtime = "runtime",
                     SuperuserSecretArn = "superuserSecretArn",
                     SuperuserSecretKmsKeyArn = "superuserSecretKmsKeyArn",
                     VpcSecurityGroupIds = "vpcSecurityGroupIds",
                     VpcSubnetIds = "vpcSubnetIds"
                 },
                 RotateImmediatelyOnUpdate = false,
                 RotationLambdaArn = "rotationLambdaArn",
                 RotationRules = new RotationRulesProperty {
                     AutomaticallyAfterDays = 123,
                     Duration = "duration",
                     ScheduleExpression = "scheduleExpression"
                 }
             });

Remarks

Sets the rotation schedule and Lambda rotation function for a secret. For more information, see How rotation works .

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For the rotation function, you have two options:

For database secrets, if you define both the secret and the database or service in the AWS CloudFormation template, then you need to define the AWS::SecretsManager::SecretTargetAttachment resource to populate the secret with the connection details of the database or service before you attempt to configure rotation.

CloudformationResource: AWS::SecretsManager::RotationSchedule

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html

ExampleMetadata: fixture=_generated

Constructors

CfnRotationSchedule(Construct, string, ICfnRotationScheduleProps)

Create a new AWS::SecretsManager::RotationSchedule.

public CfnRotationSchedule(Construct scope, string id, ICfnRotationScheduleProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnRotationScheduleProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

HostedRotationLambda

Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify RotationLambdaARN instead.

public virtual object? HostedRotationLambda { get; set; }

Property Value

object

Remarks

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda

RotateImmediatelyOnUpdate

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

public virtual object? RotateImmediatelyOnUpdate { get; set; }

Property Value

object

Remarks

The rotation schedule is defined in RotationRules .

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Rotation is an asynchronous process. For more information, see How rotation works .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotateimmediatelyonupdate

RotationLambdaArn

The ARN of an existing Lambda rotation function.

public virtual string? RotationLambdaArn { get; set; }

Property Value

string

Remarks

To specify a rotation function that is also defined in this template, use the Ref function.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

To create a new rotation function based on one of the Secrets Manager rotation function templates , specify HostedRotationLambda instead.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationlambdaarn

RotationRules

A structure that defines the rotation configuration for this secret.

public virtual object? RotationRules { get; set; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationrules

SecretId

The ARN or name of the secret to rotate.

public virtual string SecretId { get; set; }

Property Value

string

Remarks

To reference a secret also created in this template, use the Ref function with the secret's logical ID.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-secretid

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>