Class CfnRotationScheduleProps

Namespace

Amazon.CDK.AWS.SecretsManager

Assembly

Amazon.CDK.AWS.SecretsManager.dll

Properties for defining a CfnRotationSchedule.

public class CfnRotationScheduleProps : ICfnRotationScheduleProps

Inheritance

object

CfnRotationScheduleProps

Implements

ICfnRotationScheduleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 cfnRotationScheduleProps = 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

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

ExampleMetadata: fixture=_generated

Constructors

CfnRotationScheduleProps()

public CfnRotationScheduleProps()

Properties

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 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 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 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 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 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