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
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.
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>
}
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