Package software.amazon.awscdk.services.rds

Class CredentialsBaseOptions.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CredentialsBaseOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CredentialsBaseOptions>

Enclosing interface:

CredentialsBaseOptions

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

A builder for CredentialsBaseOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CredentialsBaseOptions	build()	Builds the configured instance.
CredentialsBaseOptions.Builder	encryptionKey(IKey encryptionKey)	Sets the value of CredentialsBaseOptions.getEncryptionKey()
CredentialsBaseOptions.Builder	excludeCharacters(String excludeCharacters)	Sets the value of CredentialsBaseOptions.getExcludeCharacters()
CredentialsBaseOptions.Builder	replicaRegions(List<? extends ReplicaRegion> replicaRegions)	Sets the value of CredentialsBaseOptions.getReplicaRegions()
CredentialsBaseOptions.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

encryptionKey

@Stability(Stable)
public CredentialsBaseOptions.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 CredentialsBaseOptions.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 CredentialsBaseOptions.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 CredentialsBaseOptions.Builder secretName(String secretName)

Sets the value of CredentialsBaseOptions.getSecretName()

Parameters:

secretName - The name of the secret.

Returns:

this

build

@Stability(Stable)
public CredentialsBaseOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CredentialsBaseOptions

Throws:

NullPointerException - if any required attribute was not provided