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
});
python
# instance: rds.DatabaseInstance
# my_security_group: ec2.SecurityGroup
instance.add_rotation_single_user(
automatically_after=Duration.days(7), # defaults to 30 days
exclude_characters="!@#$%^&*", # defaults to the set " %+~`#/// here*()|[]{}:;<>?!'/@\"\\"
security_group=my_security_group
)
java
DatabaseInstance instance;
SecurityGroup mySecurityGroup;
instance.addRotationSingleUser(RotationSingleUserOptions.builder()
.automaticallyAfter(Duration.days(7)) // defaults to 30 days
.excludeCharacters("!@#$%^&*") // defaults to the set " %+~`#/// here*()|[]{}:;<>?!'/@\"\\"
.securityGroup(mySecurityGroup)
.build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
DatabaseInstance instance;
SecurityGroup mySecurityGroup;
instance.AddRotationSingleUser(new RotationSingleUserOptions {
AutomaticallyAfter = Duration.Days(7), // defaults to 30 days
ExcludeCharacters = "!@#$%^&*", // defaults to the set " %+~`#/// here*()|[]{}:;<>?!'/@\"\\"
SecurityGroup = mySecurityGroup
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var instance DatabaseInstance
var mySecurityGroup SecurityGroup
instance.addRotationSingleUser(&RotationSingleUserOptions{
AutomaticallyAfter: awscdk.Duration_Days(jsii.Number(7)),
// defaults to 30 days
ExcludeCharacters: jsii.String("!@#$%^&*"),
// defaults to the set " %+~`#/// here*()|[]{}:;<>?!'/@\"\\"
SecurityGroup: mySecurityGroup,
})
Properties
automaticallyAfteroptionalDurationautomatically_afteroptionalDurationautomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDuration#Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
Default: 30 days
endpointoptionalIInterfaceVpcEndpointendpointoptionalIInterfaceVpcEndpointendpointoptionalIInterfaceVpcEndpointEndpointoptionalIInterfaceVpcEndpointEndpointoptionalIInterfaceVpcEndpoint#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.
excludeCharactersoptionalstringexclude_charactersoptionalstrexcludeCharactersoptionalStringExcludeCharactersoptionalstringExcludeCharactersoptional*string#Specifies characters to not include in generated passwords.
Default: " %+~`#$&*()|[]{}:;<>?!'/@"\"
rotateImmediatelyOnUpdateoptionalbooleanrotate_immediately_on_updateoptionalboolrotateImmediatelyOnUpdateoptionalBooleanRotateImmediatelyOnUpdateoptionalboolRotateImmediatelyOnUpdateoptional*bool= true#Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup#The security group for the Lambda rotation function.
Default: a new security group is created
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Where to place the rotation Lambda function.
Default: same placement as instance or cluster