software.amazon.awscdk.services.redshift

Class UserProps.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.UserProps.Builder

Enclosing interface:

UserProps

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

A builder for UserProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UserProps.Builder	adminUser(ISecret adminUser) Sets the value of DatabaseOptions.getAdminUser()
UserProps	build() Builds the configured instance.
UserProps.Builder	cluster(ICluster cluster) Sets the value of DatabaseOptions.getCluster()
UserProps.Builder	databaseName(java.lang.String databaseName) Sets the value of DatabaseOptions.getDatabaseName()
UserProps.Builder	encryptionKey(IKey encryptionKey) Sets the value of UserProps.getEncryptionKey()
UserProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of UserProps.getRemovalPolicy()
UserProps.Builder	username(java.lang.String username) Sets the value of UserProps.getUsername()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

encryptionKey

public UserProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of UserProps.getEncryptionKey()

Parameters:

encryptionKey - KMS key to encrypt the generated secret.

Returns:

this

removalPolicy

public UserProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of UserProps.getRemovalPolicy()

Parameters:

removalPolicy - The policy to apply when this resource is removed from the application.

Returns:

this

username

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

Sets the value of UserProps.getUsername()

Parameters:

username - The name of the user. For valid values, see: https://docs.aws.amazon.com/redshift/latest/dg/r_names.html

Returns:

this

cluster

public UserProps.Builder cluster(ICluster cluster)

Sets the value of DatabaseOptions.getCluster()

Parameters:

cluster - The cluster containing the database. This parameter is required.

Returns:

this

databaseName

public UserProps.Builder databaseName(java.lang.String databaseName)

Sets the value of DatabaseOptions.getDatabaseName()

Parameters:

databaseName - The name of the database. This parameter is required.

Returns:

this

adminUser

public UserProps.Builder adminUser(ISecret adminUser)

Sets the value of DatabaseOptions.getAdminUser()

Parameters:

adminUser - The secret containing credentials to a Redshift user with administrator privileges. Secret JSON schema: { username: string; password: string }.

Returns:

this

build

public UserProps build()

Builds the configured instance.

Returns:

a new instance of UserProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided