Interface ILogin
Login credentials for a database cluster.
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.AWS.DocDB.dll
Syntax (csharp)
public interface ILogin
Syntax (vb)
Public Interface ILogin
Remarks
ExampleMetadata: infused
Examples
Vpc vpc;
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
MasterUser = new Login {
Username = "myuser", // NOTE: 'admin' is reserved by DocumentDB
ExcludeCharacters = "\"@/:", // optional, defaults to the set "\"@/" and is also used for eventually created rotations
SecretName = "/myapp/mydocdb/masteruser"
},
InstanceType = InstanceType.Of(InstanceClass.R5, InstanceSize.LARGE),
VpcSubnets = new SubnetSelection {
SubnetType = SubnetType.PUBLIC
},
Vpc = vpc
});
Synopsis
Properties
ExcludeCharacters | Specifies characters to not include in generated passwords. |
KmsKey | KMS encryption key to encrypt the generated secret. |
Password | Password. |
SecretName | The physical name of the secret, that will be generated. |
Username | Username. |
Properties
ExcludeCharacters
Specifies characters to not include in generated passwords.
virtual string ExcludeCharacters { get; }
Property Value
System.String
Remarks
Default: ""
: /"
KmsKey
KMS encryption key to encrypt the generated secret.
virtual IKey KmsKey { get; }
Property Value
Remarks
Default: default master key
Password
Password.
virtual SecretValue Password { get; }
Property Value
Remarks
Do not put passwords in your CDK code directly.
Default: a Secrets Manager generated password
SecretName
The physical name of the secret, that will be generated.
virtual string SecretName { get; }
Property Value
System.String
Remarks
Default: Secretsmanager will generate a physical name for the secret
Username
Username.
string Username { get; }
Property Value
System.String