Package software.amazon.awscdk.services.rds

Class CredentialsFromUsernameOptions.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CredentialsFromUsernameOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CredentialsFromUsernameOptions>

Enclosing interface:

CredentialsFromUsernameOptions

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

A builder for CredentialsFromUsernameOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CredentialsFromUsernameOptions	build()	Builds the configured instance.
CredentialsFromUsernameOptions.Builder	encryptionKey(IKey encryptionKey)	Sets the value of CredentialsBaseOptions.getEncryptionKey()
CredentialsFromUsernameOptions.Builder	excludeCharacters(String excludeCharacters)	Sets the value of CredentialsBaseOptions.getExcludeCharacters()
CredentialsFromUsernameOptions.Builder	password(SecretValue password)	Sets the value of CredentialsFromUsernameOptions.getPassword()
CredentialsFromUsernameOptions.Builder	replicaRegions(List<? extends ReplicaRegion> replicaRegions)	Sets the value of CredentialsBaseOptions.getReplicaRegions()
CredentialsFromUsernameOptions.Builder	secretName(String secretName)	Sets the value of CredentialsBaseOptions.getSecretName()

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

password

@Stability(Stable)
public CredentialsFromUsernameOptions.Builder password(SecretValue password)

Sets the value of CredentialsFromUsernameOptions.getPassword()

Parameters:

password - Password. Do not put passwords in your CDK code directly.

Returns:

this

encryptionKey

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

Sets the value of CredentialsBaseOptions.getEncryptionKey()

Parameters:

encryptionKey - KMS encryption key to encrypt the generated secret.

Returns:

this

excludeCharacters

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

Sets the value of CredentialsBaseOptions.getExcludeCharacters()

Parameters:

excludeCharacters - The characters to exclude from the generated password. Has no effect if password has been provided.

Returns:

this

replicaRegions

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

Sets the value of CredentialsBaseOptions.getReplicaRegions()

Parameters:

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

Returns:

this

secretName

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

Sets the value of CredentialsBaseOptions.getSecretName()

Parameters:

secretName - The name of the secret.

Returns:

this

build

@Stability(Stable)
public CredentialsFromUsernameOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CredentialsFromUsernameOptions

Throws:

NullPointerException - if any required attribute was not provided