software.amazon.awscdk.services.docdb

Interface Login

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Login.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.027Z")
 @Stability(value=Stable)
public interface Login
extends software.amazon.jsii.JsiiSerializable

Login credentials for a database cluster.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .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")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.MEMORY5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Login.Builder A builder for Login
static class	Login.Jsii$Proxy An implementation for Login

Method Summary

Modifier and Type	Method and Description
static Login.Builder	builder()
default String	getExcludeCharacters() Specifies characters to not include in generated passwords.
default IKey	getKmsKey() KMS encryption key to encrypt the generated secret.
default SecretValue	getPassword() Password.
default String	getSecretName() The physical name of the secret, that will be generated.
String	getUsername() Username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUsername

@Stability(value=Stable)
 @NotNull
String getUsername()

Username.

getExcludeCharacters

@Stability(value=Stable)
 @Nullable
default String getExcludeCharacters()

Specifies characters to not include in generated passwords.

Default: "\"

getKmsKey

@Stability(value=Stable)
 @Nullable
default IKey getKmsKey()

KMS encryption key to encrypt the generated secret.

Default: default master key

getPassword

@Stability(value=Stable)
 @Nullable
default SecretValue getPassword()

Password.

Do not put passwords in your CDK code directly.

Default: a Secrets Manager generated password

getSecretName

@Stability(value=Stable)
 @Nullable
default String getSecretName()

The physical name of the secret, that will be generated.

Default: Secretsmanager will generate a physical name for the secret

builder

@Stability(value=Stable)
static Login.Builder builder()

Returns:

a Login.Builder of Login