software.amazon.awscdk.services.redshift

Class Table.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.Table.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Table>

Enclosing class:

Table

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

(experimental) A fluent builder for Table.

Method Summary

Modifier and Type	Method and Description
Table.Builder	adminUser(ISecret adminUser) (experimental) The secret containing credentials to a Redshift user with administrator privileges.
Table	build()
Table.Builder	cluster(ICluster cluster) (experimental) The cluster containing the database.
static Table.Builder	create(software.constructs.Construct scope, String id)
Table.Builder	databaseName(String databaseName) (experimental) The name of the database.
Table.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) The policy to apply when this resource is removed from the application.
Table.Builder	tableColumns(List<? extends Column> tableColumns) (experimental) The columns of the table.
Table.Builder	tableName(String tableName) (experimental) The name of the table.

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Table.Builder.

cluster

@Stability(value=Experimental)
public Table.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 Table.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 Table.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

tableColumns

@Stability(value=Experimental)
public Table.Builder tableColumns(List<? extends Column> tableColumns)

(experimental) The columns of the table.

Parameters:

tableColumns - The columns of the table. This parameter is required.

Returns:

this

removalPolicy

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

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

Default: cdk.RemovalPolicy.Retain

Parameters:

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

Returns:

this

tableName

@Stability(value=Experimental)
public Table.Builder tableName(String tableName)

(experimental) The name of the table.

Default: - a name is generated

Parameters:

tableName - The name of the table. This parameter is required.

Returns:

this

build

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

Specified by:

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