Skip to content
v2.274.0

RotationSingleUserOptions Struct ​

Options to add the multi user rotation.

Example ​

ts
declare const instance: rds.DatabaseInstance;
declare const mySecurityGroup: ec2.SecurityGroup;

instance.addRotationSingleUser({
  automaticallyAfter: Duration.days(7), // defaults to 30 days
  excludeCharacters: '!@#$%^&*', // defaults to the set " %+~`#$&*()|[]{}:;<>?!'/@\"\\"
  securityGroup: mySecurityGroup, // defaults to an auto-created security group
});

Properties ​

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

Default: 30 days

The VPC interface endpoint to use for the Secrets Manager API.

Default: https://secretsmanager.<region>.amazonaws.com

notes

If you enable private DNS hostnames for your VPC private endpoint (the default), you don't need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager CLI and SDKs use by default (https://secretsmanager.<region>.amazonaws.com) automatically resolves to your VPC endpoint.

excludeCharactersstringexclude_charactersstrexcludeCharactersStringExcludeCharactersstringExcludeCharacters*string#
Specifies characters to not include in generated passwords.

Default: " %+~`#$&*()|[]{}:;<>?!'/@"\"

rotateImmediatelyOnUpdatebooleanrotate_immediately_on_updateboolrotateImmediatelyOnUpdateBooleanRotateImmediatelyOnUpdateboolRotateImmediatelyOnUpdate*bool= true#
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup#
The security group for the Lambda rotation function.

Default: a new security group is created

vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection#
Where to place the rotation Lambda function.

Default: same placement as instance or cluster