aws-cdk-lib.aws_secretsmanager.SingleUserHostedRotationOptions

interface SingleUserHostedRotationOptions

LanguageType name
.NETAmazon.CDK.AWS.SecretsManager.SingleUserHostedRotationOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssecretsmanager#SingleUserHostedRotationOptions
Javasoftware.amazon.awscdk.services.secretsmanager.SingleUserHostedRotationOptions
Pythonaws_cdk.aws_secretsmanager.SingleUserHostedRotationOptions
TypeScript (source)aws-cdk-lib » aws_secretsmanager » SingleUserHostedRotationOptions

Single user hosted rotation options.

Example

declare const myVpc: ec2.IVpc;
declare const dbConnections: ec2.Connections;
declare const secret: secretsmanager.Secret;

const myHostedRotation = secretsmanager.HostedRotation.mysqlSingleUser({ vpc: myVpc });
secret.addRotationSchedule('RotationSchedule', { hostedRotation: myHostedRotation });
dbConnections.allowDefaultPortFrom(myHostedRotation);

Properties

NameTypeDescription
excludeCharacters?stringA string of the characters that you don't want in the password.
functionName?stringA name for the Lambda created to rotate the secret.
securityGroups?ISecurityGroup[]A list of security groups for the Lambda created to rotate the secret.
vpc?IVpcThe VPC where the Lambda rotation function will run.
vpcSubnets?SubnetSelectionThe type of subnets in the VPC where the Lambda rotation function will run.

excludeCharacters?

Type: string (optional, default: the same exclude characters as the ones used for the secret or " %+~`#$&()|[]{}:;<>?!'/@"\")*

A string of the characters that you don't want in the password.


functionName?

Type: string (optional, default: a CloudFormation generated name)

A name for the Lambda created to rotate the secret.


securityGroups?

Type: ISecurityGroup[] (optional, default: a new security group is created)

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


vpc?

Type: IVpc (optional, default: the Lambda is not deployed in a VPC)

The VPC where the Lambda rotation function will run.


vpcSubnets?

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified.)

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