Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.938Z") @Stability(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.R5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .build();

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • getUsername

      @Stability(Stable) @NotNull String getUsername()
      Username.

    • getExcludeCharacters

      @Stability(Stable) @Nullable default String getExcludeCharacters()
      Specifies characters to not include in generated passwords.

      Default: "\"

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      KMS encryption key to encrypt the generated secret.

      Default: default master key

    • getPassword

      @Stability(Stable) @Nullable default SecretValue getPassword()
      Password.

      Do not put passwords in your CDK code directly.

      Default: a Secrets Manager generated password

    • getSecretName

      @Stability(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(Stable) static Login.Builder builder()
      Returns:
      a Login.Builder of Login