Interface ICommonRotationUserOptions

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

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICommonRotationUserOptions

Syntax (vb)

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

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.

Properties

AutomaticallyAfter

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

Duration? AutomaticallyAfter { get; }

Property Value

Duration

Remarks

Default: - 30 days

Endpoint

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

IInterfaceVpcEndpoint? Endpoint { get; }

Property Value

IInterfaceVpcEndpoint

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

ExcludeCharacters

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

string? ExcludeCharacters { get; }

Property Value

string

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

RotateImmediatelyOnUpdate

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

bool? RotateImmediatelyOnUpdate { get; }

Property Value

bool?

Remarks

Default: true

SecurityGroup

The security group for the Lambda rotation function.

ISecurityGroup? SecurityGroup { get; }

Property Value

ISecurityGroup

Remarks

Default: - a new security group is created

VpcSubnets

Where to place the rotation Lambda function.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - same placement as instance or cluster