Class MultiUserHostedRotationOptions

Namespace

Amazon.CDK.AWS.SecretsManager

Assembly

Amazon.CDK.AWS.SecretsManager.dll

Multi user hosted rotation options.

public class MultiUserHostedRotationOptions : IMultiUserHostedRotationOptions, ISingleUserHostedRotationOptions

Inheritance

object

MultiUserHostedRotationOptions

Implements

IMultiUserHostedRotationOptions

ISingleUserHostedRotationOptions

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.EC2;
            using Amazon.CDK.AWS.SecretsManager;

            Secret secret;
            SecurityGroup securityGroup;
            Subnet subnet;
            SubnetFilter subnetFilter;
            Vpc vpc;

            var multiUserHostedRotationOptions = new MultiUserHostedRotationOptions {
                MasterSecret = secret,

                // the properties below are optional
                FunctionName = "functionName",
                SecurityGroups = new [] { securityGroup },
                Vpc = vpc,
                VpcSubnets = new SubnetSelection {
                    AvailabilityZones = new [] { "availabilityZones" },
                    OnePerAz = false,
                    SubnetFilters = new [] { subnetFilter },
                    SubnetGroupName = "subnetGroupName",
                    SubnetName = "subnetName",
                    Subnets = new [] { subnet },
                    SubnetType = SubnetType.ISOLATED
                }
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

MultiUserHostedRotationOptions()

public MultiUserHostedRotationOptions()

Properties

FunctionName

A name for the Lambda created to rotate the secret.

public string? FunctionName { get; set; }

Property Value

string

Remarks

Default: - a CloudFormation generated name

MasterSecret

The master secret for a multi user rotation scheme.

public ISecret MasterSecret { get; set; }

Property Value

ISecret

SecurityGroups

A list of security groups for the Lambda created to rotate the secret.

public ISecurityGroup[]? SecurityGroups { get; set; }

Property Value

ISecurityGroup[]

Remarks

Default: - a new security group is created

Vpc

The VPC where the Lambda rotation function will run.

public IVpc? Vpc { get; set; }

Property Value

IVpc

Remarks

Default: - the Lambda is not deployed in a VPC

VpcSubnets

The type of subnets in the VPC where the Lambda rotation function will run.

public ISubnetSelection? VpcSubnets { get; set; }

Property Value

ISubnetSelection

Remarks

Default: - the Vpc default strategy if not specified.