Package software.amazon.awscdk.services.rds

Class DatabaseSecretProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseSecretProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseSecretProps>

Enclosing interface:

DatabaseSecretProps

@Stability(Stable)
public static final class DatabaseSecretProps.Builder
extends Object
implements software.amazon.jsii.Builder<DatabaseSecretProps>

A builder for DatabaseSecretProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DatabaseSecretProps	build()	Builds the configured instance.
DatabaseSecretProps.Builder	dbname(String dbname)	Sets the value of DatabaseSecretProps.getDbname()
DatabaseSecretProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of DatabaseSecretProps.getEncryptionKey()
DatabaseSecretProps.Builder	excludeCharacters(String excludeCharacters)	Sets the value of DatabaseSecretProps.getExcludeCharacters()
DatabaseSecretProps.Builder	masterSecret(ISecret masterSecret)	Sets the value of DatabaseSecretProps.getMasterSecret()
DatabaseSecretProps.Builder	replaceOnPasswordCriteriaChanges(Boolean replaceOnPasswordCriteriaChanges)	Sets the value of DatabaseSecretProps.getReplaceOnPasswordCriteriaChanges()
DatabaseSecretProps.Builder	replicaRegions(List<? extends ReplicaRegion> replicaRegions)	Sets the value of DatabaseSecretProps.getReplicaRegions()
DatabaseSecretProps.Builder	secretName(String secretName)	Sets the value of DatabaseSecretProps.getSecretName()
DatabaseSecretProps.Builder	username(String username)	Sets the value of DatabaseSecretProps.getUsername()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

username

@Stability(Stable)
public DatabaseSecretProps.Builder username(String username)

Sets the value of DatabaseSecretProps.getUsername()

Parameters:

username - The username. This parameter is required.

Returns:

this

dbname

@Stability(Stable)
public DatabaseSecretProps.Builder dbname(String dbname)

Sets the value of DatabaseSecretProps.getDbname()

Parameters:

dbname - The database name, if not using the default one.

Returns:

this

encryptionKey

@Stability(Stable)
public DatabaseSecretProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of DatabaseSecretProps.getEncryptionKey()

Parameters:

encryptionKey - The KMS key to use to encrypt the secret.

Returns:

this

excludeCharacters

@Stability(Stable)
public DatabaseSecretProps.Builder excludeCharacters(String excludeCharacters)

Sets the value of DatabaseSecretProps.getExcludeCharacters()

Parameters:

excludeCharacters - Characters to not include in the generated password.

Returns:

this

masterSecret

@Stability(Stable)
public DatabaseSecretProps.Builder masterSecret(ISecret masterSecret)

Sets the value of DatabaseSecretProps.getMasterSecret()

Parameters:

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

Returns:

this

replaceOnPasswordCriteriaChanges

@Stability(Stable)
public DatabaseSecretProps.Builder replaceOnPasswordCriteriaChanges(Boolean replaceOnPasswordCriteriaChanges)

Sets the value of DatabaseSecretProps.getReplaceOnPasswordCriteriaChanges()

Parameters:

replaceOnPasswordCriteriaChanges - 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.

Returns:

this

replicaRegions

@Stability(Stable)
public DatabaseSecretProps.Builder replicaRegions(List<? extends ReplicaRegion> replicaRegions)

Sets the value of DatabaseSecretProps.getReplicaRegions()

Parameters:

replicaRegions - A list of regions where to replicate this secret.

Returns:

this

secretName

@Stability(Stable)
public DatabaseSecretProps.Builder secretName(String secretName)

Sets the value of DatabaseSecretProps.getSecretName()

Parameters:

secretName - A name for the secret.

Returns:

this

build

@Stability(Stable)
public DatabaseSecretProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseSecretProps

Throws:

NullPointerException - if any required attribute was not provided