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:42.850Z") @Stability(Experimental) public interface Login extends software.amazon.jsii.JsiiSerializable
(experimental) Username and password combination.

Example:

 User user = User.Builder.create(this, "User")
         .cluster(cluster)
         .databaseName("databaseName")
         .build();
 cluster.addRotationMultiUser("MultiUserRotation", RotationMultiUserOptions.builder()
         .secret(user.getSecret())
         .build());
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for Login
    static final class 
    An implementation for Login
  • Method Summary

    Modifier and Type
    Method
    Description
     
    default IKey
    (experimental) KMS encryption key to encrypt the generated secret.
    default SecretValue
    (experimental) Password.
    (experimental) Username.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getMasterUsername

      @Stability(Experimental) @NotNull String getMasterUsername()
      (experimental) Username.
    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKey getEncryptionKey()
      (experimental) KMS encryption key to encrypt the generated secret.

      Default: default master key

    • getMasterPassword

      @Stability(Experimental) @Nullable default SecretValue getMasterPassword()
      (experimental) Password.

      Do not put passwords in your CDK code directly.

      Default: a Secrets Manager generated password

    • builder

      @Stability(Experimental) static Login.Builder builder()
      Returns:
      a Login.Builder of Login