MultiUserHostedRotationOptions Struct
Multi user hosted rotation options.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
declare const secret: secretsmanager.Secret;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const multiUserHostedRotationOptions: secretsmanager.MultiUserHostedRotationOptions = {
masterSecret: secret,
// the properties below are optional
excludeCharacters: 'excludeCharacters',
functionName: 'functionName',
securityGroups: [securityGroup],
vpc: vpc,
vpcSubnets: {
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
},
};
Properties
excludeCharactersoptionalstringexclude_charactersoptionalstrexcludeCharactersoptionalStringExcludeCharactersoptionalstringExcludeCharactersoptional*string#A string of the characters that you don't want in the password.
Default: the same exclude characters as the ones used for the secret or " %+~`#$&*()|[]{}:;<>?!'/@"\"
functionNameoptionalstringfunction_nameoptionalstrfunctionNameoptionalStringFunctionNameoptionalstringFunctionNameoptional*string#A name for the Lambda created to rotate the secret.
Default: a CloudFormation generated name
masterSecretISecretmaster_secretISecretmasterSecretISecretMasterSecretISecretMasterSecretISecretrequired#The master secret for a multi user rotation scheme.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#A list of security groups for the Lambda created to rotate the secret.
Default: a new security group is created
The VPC where the Lambda rotation function will run.
Default: the Lambda is not deployed in a VPC
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#The type of subnets in the VPC where the Lambda rotation function will run.
Default: the Vpc default strategy if not specified.