Class RotationMultiUserOptions
Options to add the multi user rotation.
Inheritance
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class RotationMultiUserOptions : Object, IRotationMultiUserOptions, ICommonRotationUserOptions
Syntax (vb)
Public Class RotationMultiUserOptions
Inherits Object
Implements IRotationMultiUserOptions, ICommonRotationUserOptions
Remarks
ExampleMetadata: infused
Examples
DatabaseInstance instance;
DatabaseSecret myImportedSecret;
instance.AddRotationMultiUser("MyUser", new RotationMultiUserOptions {
Secret = myImportedSecret
});
Synopsis
Constructors
RotationMultiUserOptions() |
Properties
AutomaticallyAfter | Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation. |
Endpoint | |
ExcludeCharacters | |
RotateImmediatelyOnUpdate | Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. |
Secret | The secret to rotate. |
SecurityGroup | The security group for the Lambda rotation function. |
VpcSubnets | Where to place the rotation Lambda function. |
Constructors
RotationMultiUserOptions()
public RotationMultiUserOptions()
Properties
AutomaticallyAfter
Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
public Duration AutomaticallyAfter { get; set; }
Property Value
Remarks
Default: - 30 days
Endpoint
ExcludeCharacters
public string ExcludeCharacters { get; set; }
Property Value
System.String
RotateImmediatelyOnUpdate
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
public Nullable<bool> RotateImmediatelyOnUpdate { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Secret
The secret to rotate.
public ISecret Secret { get; set; }
Property Value
Remarks
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>
}
SecurityGroup
The security group for the Lambda rotation function.
public ISecurityGroup SecurityGroup { get; set; }
Property Value
Remarks
Default: - a new security group is created
VpcSubnets
Where to place the rotation Lambda function.
public ISubnetSelection VpcSubnets { get; set; }
Property Value
Remarks
Default: - same placement as instance or cluster