software.amazon.awscdk.services.redshift

Class User.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.User.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<User>

Enclosing class:

User

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

(experimental) A fluent builder for User.

Method Summary

Modifier and Type	Method and Description
User.Builder	adminUser(ISecret adminUser) (experimental) The secret containing credentials to a Redshift user with administrator privileges.
User	build()
User.Builder	cluster(ICluster cluster) (experimental) The cluster containing the database.
static User.Builder	create(software.constructs.Construct scope, String id)
User.Builder	databaseName(String databaseName) (experimental) The name of the database.
User.Builder	encryptionKey(IKey encryptionKey) (experimental) KMS key to encrypt the generated secret.
User.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) The policy to apply when this resource is removed from the application.
User.Builder	username(String username) (experimental) The name of the user.

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 User.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of User.Builder.

cluster

@Stability(value=Experimental)
public User.Builder cluster(ICluster cluster)

(experimental) The cluster containing the database.

Parameters:

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

Returns:

this

databaseName

@Stability(value=Experimental)
public User.Builder databaseName(String databaseName)

(experimental) The name of the database.

Parameters:

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

Returns:

this

adminUser

@Stability(value=Experimental)
public User.Builder adminUser(ISecret adminUser)

(experimental) The secret containing credentials to a Redshift user with administrator privileges.

Secret JSON schema: { username: string; password: string }.

Default: - the admin secret is taken from the cluster

Parameters:

adminUser - The secret containing credentials to a Redshift user with administrator privileges. This parameter is required.

Returns:

this

encryptionKey

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

(experimental) KMS key to encrypt the generated secret.

Default: - the default AWS managed key is used

Parameters:

encryptionKey - KMS key to encrypt the generated secret. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public User.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) The policy to apply when this resource is removed from the application.

Default: cdk.RemovalPolicy.Destroy

Parameters:

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

Returns:

this

username

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

(experimental) The name of the user.

For valid values, see: https://docs.aws.amazon.com/redshift/latest/dg/r_names.html

Default: - a name is generated

Parameters:

username - The name of the user. This parameter is required.

Returns:

this

build

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

Specified by:

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