software.amazon.awscdk.services.rds

Class DatabaseSecret.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseSecret.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseSecret>

Enclosing class:

DatabaseSecret

@Stability(value=Experimental)
public static final class DatabaseSecret.Builder
extends Object
implements software.amazon.jsii.Builder<DatabaseSecret>

(experimental) A fluent builder for DatabaseSecret.

Method Summary

Modifier and Type	Method and Description
DatabaseSecret	build()
static DatabaseSecret.Builder	create(software.constructs.Construct scope, String id)
DatabaseSecret.Builder	encryptionKey(IKey encryptionKey) (experimental) The KMS key to use to encrypt the secret.
DatabaseSecret.Builder	excludeCharacters(String excludeCharacters) (experimental) Characters to not include in the generated password.
DatabaseSecret.Builder	masterSecret(ISecret masterSecret) (experimental) The master secret which will be used to rotate this secret.
DatabaseSecret.Builder	replaceOnPasswordCriteriaChanges(Boolean replaceOnPasswordCriteriaChanges) (experimental) Whether to replace this secret when the criteria for the password change.
DatabaseSecret.Builder	secretName(String secretName) (experimental) A name for the secret.
DatabaseSecret.Builder	username(String username) (experimental) The username.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static DatabaseSecret.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DatabaseSecret.Builder.

username

@Stability(value=Experimental)
public DatabaseSecret.Builder username(String username)

(experimental) The username.

Parameters:

username - The username. This parameter is required.

Returns:

this

encryptionKey

@Stability(value=Experimental)
public DatabaseSecret.Builder encryptionKey(IKey encryptionKey)

(experimental) 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

@Stability(value=Experimental)
public DatabaseSecret.Builder excludeCharacters(String excludeCharacters)

(experimental) 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

@Stability(value=Experimental)
public DatabaseSecret.Builder masterSecret(ISecret masterSecret)

(experimental) 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

replaceOnPasswordCriteriaChanges

@Stability(value=Experimental)
public DatabaseSecret.Builder replaceOnPasswordCriteriaChanges(Boolean replaceOnPasswordCriteriaChanges)

(experimental) Whether to replace this secret when the criteria for the password change.

This is achieved by overriding the logical id of the AWS::SecretsManager::Secret with a hash of the options that influence the password generation. This way a new secret will be created when the password is regenerated and the cluster or instance consuming this secret will have its credentials updated.

Default: false

Parameters:

replaceOnPasswordCriteriaChanges - Whether to replace this secret when the criteria for the password change. This parameter is required.

Returns:

this

secretName

@Stability(value=Experimental)
public DatabaseSecret.Builder secretName(String secretName)

(experimental) A name for the secret.

Default: - A name is generated by CloudFormation.

Parameters:

secretName - A name for the secret. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DatabaseSecret build()

Specified by:

build in interface software.amazon.jsii.Builder<DatabaseSecret>