software.amazon.awscdk.services.rds

Class Credentials

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.Credentials

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.24.0 (build b722f66)",
           date="2021-03-11T13:46:51.507Z")
 @Stability(value=Stable)
public abstract class Credentials
extends software.amazon.jsii.JsiiObject

Username and password combination.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Credentials()
protected	Credentials(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Credentials(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Credentials	fromGeneratedSecret(String username) Creates Credentials with a password generated and stored in Secrets Manager.
static Credentials	fromGeneratedSecret(String username, CredentialsBaseOptions options) Creates Credentials with a password generated and stored in Secrets Manager.
static Credentials	fromPassword(String username, SecretValue password) Creates Credentials from a password.
static Credentials	fromSecret(ISecret secret) Creates Credentials from an existing Secrets Manager ``Secret`` (or ``DatabaseSecret``).
static Credentials	fromSecret(ISecret secret, String username) Creates Credentials from an existing Secrets Manager ``Secret`` (or ``DatabaseSecret``).
static Credentials	fromUsername(String username) Deprecated. use `fromGeneratedSecret()` or `fromPassword()` for new Clusters and Instances. Note that switching from `fromUsername()` to `fromGeneratedSecret()` or `fromPassword()` for already deployed Clusters or Instances will result in their replacement!
static Credentials	fromUsername(String username, CredentialsFromUsernameOptions options) Deprecated. use `fromGeneratedSecret()` or `fromPassword()` for new Clusters and Instances. Note that switching from `fromUsername()` to `fromGeneratedSecret()` or `fromPassword()` for already deployed Clusters or Instances will result in their replacement!
abstract IKey	getEncryptionKey() KMS encryption key to encrypt the generated secret.
abstract String	getExcludeCharacters() The characters to exclude from the generated password.
abstract SecretValue	getPassword() Password.
abstract ISecret	getSecret() Secret used to instantiate this Login.
abstract String	getUsername() Username.
abstract Boolean	getUsernameAsString() Whether the username should be referenced as a string and not as a dynamic reference to the username in the secret.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Credentials

protected Credentials(software.amazon.jsii.JsiiObjectRef objRef)

Credentials

protected Credentials(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Credentials

@Stability(value=Stable)
protected Credentials()

Method Detail

fromGeneratedSecret

@Stability(value=Stable)
 @NotNull
public static Credentials fromGeneratedSecret(@NotNull
                                                                                 String username,
                                                                                 @Nullable
                                                                                 CredentialsBaseOptions options)

Creates Credentials with a password generated and stored in Secrets Manager.

Parameters:

username - This parameter is required.

options -

fromGeneratedSecret

@Stability(value=Stable)
 @NotNull
public static Credentials fromGeneratedSecret(@NotNull
                                                                                 String username)

Creates Credentials with a password generated and stored in Secrets Manager.

Parameters:

username - This parameter is required.

fromPassword

@Stability(value=Stable)
 @NotNull
public static Credentials fromPassword(@NotNull
                                                                          String username,
                                                                          @NotNull
                                                                          SecretValue password)

Creates Credentials from a password.

Do not put passwords in your CDK code directly.

Parameters:

username - This parameter is required.

password - This parameter is required.

fromSecret

@Stability(value=Stable)
 @NotNull
public static Credentials fromSecret(@NotNull
                                                                        ISecret secret,
                                                                        @Nullable
                                                                        String username)

Creates Credentials from an existing Secrets Manager ``Secret`` (or ``DatabaseSecret``).

The Secret must be a JSON string with a username and password field:

 {
    ...
    "username": <required: username>,
    "password": <required: password>,
 }
 

Parameters:

secret - The secret where the credentials are stored. This parameter is required.

username - The username defined in the secret.

fromSecret

@Stability(value=Stable)
 @NotNull
public static Credentials fromSecret(@NotNull
                                                                        ISecret secret)

Creates Credentials from an existing Secrets Manager ``Secret`` (or ``DatabaseSecret``).

The Secret must be a JSON string with a username and password field:

 {
    ...
    "username": <required: username>,
    "password": <required: password>,
 }
 

Parameters:

secret - The secret where the credentials are stored. This parameter is required.

fromUsername

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public static Credentials fromUsername(@NotNull
                                                                                           String username,
                                                                                           @Nullable
                                                                                           CredentialsFromUsernameOptions options)

Deprecated. use `fromGeneratedSecret()` or `fromPassword()` for new Clusters and Instances. Note that switching from `fromUsername()` to `fromGeneratedSecret()` or `fromPassword()` for already deployed Clusters or Instances will result in their replacement!

(deprecated) Creates Credentials for the given username, and optional password and key.

If no password is provided, one will be generated and stored in Secrets Manager.

Parameters:

username - This parameter is required.

options -

fromUsername

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public static Credentials fromUsername(@NotNull
                                                                                           String username)

Deprecated. use `fromGeneratedSecret()` or `fromPassword()` for new Clusters and Instances. Note that switching from `fromUsername()` to `fromGeneratedSecret()` or `fromPassword()` for already deployed Clusters or Instances will result in their replacement!

(deprecated) Creates Credentials for the given username, and optional password and key.

If no password is provided, one will be generated and stored in Secrets Manager.

Parameters:

username - This parameter is required.

getUsername

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

Username.

getEncryptionKey

@Stability(value=Stable)
 @Nullable
public abstract IKey getEncryptionKey()

KMS encryption key to encrypt the generated secret.

Default: - default master key

getExcludeCharacters

@Stability(value=Stable)
 @Nullable
public abstract String getExcludeCharacters()

The characters to exclude from the generated password.

Only used if {@link password} has not been set.

Default: - the DatabaseSecret default exclude character set (" %+~`#$&*()|[]{}:;<>?!'/

getPassword

@Stability(value=Stable)
 @Nullable
public abstract SecretValue getPassword()

Password.

Do not put passwords in your CDK code directly.

Default: - a Secrets Manager generated password

getSecret

@Stability(value=Stable)
 @Nullable
public abstract ISecret getSecret()

Secret used to instantiate this Login.

Default: - none

getUsernameAsString

@Stability(value=Stable)
 @Nullable
public abstract Boolean getUsernameAsString()

Whether the username should be referenced as a string and not as a dynamic reference to the username in the secret.

Default: false