RotationMultiUserOptions Struct
Options to add the multi user rotation.
Example
ts
declare const instance: rds.DatabaseInstance;
declare const myImportedSecret: rds.DatabaseSecret;
instance.addRotationMultiUser('MyUser', {
secret: myImportedSecret, // This secret must have the `masterarn` key
});
Properties
automaticallyAfterDurationautomatically_afterDurationautomaticallyAfterDurationAutomaticallyAfterDurationAutomaticallyAfterDuration= 30 days#Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
endpointIInterfaceVpcEndpointendpointIInterfaceVpcEndpointendpointIInterfaceVpcEndpointEndpointIInterfaceVpcEndpointEndpointIInterfaceVpcEndpoint= https://secretsmanager.<region>.…#The VPC interface endpoint to use for the Secrets Manager API.
notes · default
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.
Default: https://secretsmanager.<region>.amazonaws.com
excludeCharactersstringexclude_charactersstrexcludeCharactersStringExcludeCharactersstringExcludeCharacters*string= " %+~`#$&*()|[]{}:;<>?!'/@\"\\"#Specifies characters to not include in generated passwords.
rotateImmediatelyOnUpdatebooleanrotate_immediately_on_updateboolrotateImmediatelyOnUpdateBooleanRotateImmediatelyOnUpdateboolRotateImmediatelyOnUpdate*bool= true#Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
The secret to rotate.
notes
It must be a JSON string with the following format:
{
"engine": <required: database engine>,
"host": <required: instance host name>,
"username": <required: username>,
"password": <required: password>,
"dbname": <optional: database name>,
"port": <optional: if not specified, default port will be used>,
"masterarn": <required: the arn of the master secret which will be used to create users/change passwords>
}
securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup= a new security group is created#The security group for the Lambda rotation function.
vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection= same placement as instance or cl…#Where to place the rotation Lambda function.
default
Default: same placement as instance or cluster