software.amazon.awscdk.services.docdb

Class DatabaseSecret.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.DatabaseSecret.Builder

Enclosing class:

DatabaseSecret

public static final class DatabaseSecret.Builder
extends java.lang.Object

A fluent builder for DatabaseSecret.

Method Summary

Modifier and Type	Method and Description
DatabaseSecret	build()
static DatabaseSecret.Builder	create(software.constructs.Construct scope, java.lang.String id)
DatabaseSecret.Builder	encryptionKey(IKey encryptionKey) The KMS key to use to encrypt the secret.
DatabaseSecret.Builder	excludeCharacters(java.lang.String excludeCharacters) Characters to not include in the generated password.
DatabaseSecret.Builder	masterSecret(ISecret masterSecret) The master secret which will be used to rotate this secret.
DatabaseSecret.Builder	secretName(java.lang.String secretName) The physical name of the secret.
DatabaseSecret.Builder	username(java.lang.String username) The username.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DatabaseSecret.Builder create(software.constructs.Construct scope,
                                            java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DatabaseSecret.Builder.

username

public DatabaseSecret.Builder username(java.lang.String username)

The username.

Parameters:

username - The username. This parameter is required.

Returns:

this

encryptionKey

public DatabaseSecret.Builder encryptionKey(IKey encryptionKey)

The KMS key to use to encrypt the secret.

Default: default master key

Parameters:

encryptionKey - The KMS key to use to encrypt the secret. This parameter is required.

Returns:

this

excludeCharacters

public DatabaseSecret.Builder excludeCharacters(java.lang.String excludeCharacters)

Characters to not include in the generated password.

Default: "\"

Parameters:

excludeCharacters - Characters to not include in the generated password. This parameter is required.

Returns:

this

masterSecret

public DatabaseSecret.Builder masterSecret(ISecret masterSecret)

The master secret which will be used to rotate this secret.

Default: - no master secret information will be included

Parameters:

masterSecret - The master secret which will be used to rotate this secret. This parameter is required.

Returns:

this

secretName

public DatabaseSecret.Builder secretName(java.lang.String secretName)

The physical name of the secret.

Default: Secretsmanager will generate a physical name for the secret

Parameters:

secretName - The physical name of the secret. This parameter is required.

Returns:

this

build

public DatabaseSecret build()