Class CommonRotationUserOptions

Properties common to single-user and multi-user rotation options.

Inheritance

object

CommonRotationUserOptions

Implements

ICommonRotationUserOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CommonRotationUserOptions : ICommonRotationUserOptions

Syntax (vb)

Public Class CommonRotationUserOptions Implements ICommonRotationUserOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

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

            InterfaceVpcEndpoint interfaceVpcEndpoint;
            SecurityGroup securityGroup;
            Subnet subnet;
            SubnetFilter subnetFilter;

            var commonRotationUserOptions = new CommonRotationUserOptions {
                AutomaticallyAfter = Duration.Minutes(30),
                Endpoint = interfaceVpcEndpoint,
                ExcludeCharacters = "excludeCharacters",
                RotateImmediatelyOnUpdate = false,
                SecurityGroup = securityGroup,
                VpcSubnets = new SubnetSelection {
                    AvailabilityZones = new [] { "availabilityZones" },
                    OnePerAz = false,
                    SubnetFilters = new [] { subnetFilter },
                    SubnetGroupName = "subnetGroupName",
                    Subnets = new [] { subnet },
                    SubnetType = SubnetType.PRIVATE_ISOLATED
                }
            };

Synopsis

Constructors

CommonRotationUserOptions()

Properties common to single-user and multi-user rotation options.

Properties

AutomaticallyAfter	Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
Endpoint	Properties common to single-user and multi-user rotation options.
ExcludeCharacters	Properties common to single-user and multi-user rotation options.
RotateImmediatelyOnUpdate	Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
SecurityGroup	The security group for the Lambda rotation function.
VpcSubnets	Where to place the rotation Lambda function.

Constructors

CommonRotationUserOptions()

Properties common to single-user and multi-user rotation options.

public CommonRotationUserOptions()

Remarks

ExampleMetadata: fixture=_generated

Examples

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

            InterfaceVpcEndpoint interfaceVpcEndpoint;
            SecurityGroup securityGroup;
            Subnet subnet;
            SubnetFilter subnetFilter;

            var commonRotationUserOptions = new CommonRotationUserOptions {
                AutomaticallyAfter = Duration.Minutes(30),
                Endpoint = interfaceVpcEndpoint,
                ExcludeCharacters = "excludeCharacters",
                RotateImmediatelyOnUpdate = false,
                SecurityGroup = securityGroup,
                VpcSubnets = new SubnetSelection {
                    AvailabilityZones = new [] { "availabilityZones" },
                    OnePerAz = false,
                    SubnetFilters = new [] { subnetFilter },
                    SubnetGroupName = "subnetGroupName",
                    Subnets = new [] { subnet },
                    SubnetType = SubnetType.PRIVATE_ISOLATED
                }
            };

Properties

AutomaticallyAfter

Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

public Duration? AutomaticallyAfter { get; set; }

Property Value

Duration

Remarks

Default: - 30 days

Endpoint

Properties common to single-user and multi-user rotation options.

public IInterfaceVpcEndpoint? Endpoint { get; set; }

Property Value

IInterfaceVpcEndpoint

Remarks

ExampleMetadata: fixture=_generated

ExcludeCharacters

Properties common to single-user and multi-user rotation options.

public string? ExcludeCharacters { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

RotateImmediatelyOnUpdate

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

public bool? RotateImmediatelyOnUpdate { get; set; }

Property Value

bool?

Remarks

Default: true

SecurityGroup

The security group for the Lambda rotation function.

public ISecurityGroup? SecurityGroup { get; set; }

Property Value

ISecurityGroup

Remarks

Default: - a new security group is created

VpcSubnets

Where to place the rotation Lambda function.

public ISubnetSelection? VpcSubnets { get; set; }

Property Value

ISubnetSelection

Remarks

Default: - same placement as instance or cluster

Implements

ICommonRotationUserOptions