software.amazon.awscdk.services.redshift

Class Table.Builder

java.lang.Object

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

Enclosing class:

Table

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

(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, java.lang.String id)
Table.Builder	databaseName(java.lang.String databaseName) (experimental) The name of the database.
Table.Builder	distStyle(TableDistStyle distStyle) (experimental) The distribution style of the table.
Table.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) The policy to apply when this resource is removed from the application.
Table.Builder	sortStyle(TableSortStyle sortStyle) (experimental) The sort style of the table.
Table.Builder	tableColumns(java.util.List<? extends Column> tableColumns) (experimental) The columns of the table.
Table.Builder	tableName(java.lang.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

public static Table.Builder create(software.constructs.Construct scope,
                                   java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Table.Builder.

cluster

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

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

(experimental) The name of the database.

Parameters:

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

Returns:

this

adminUser

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

public Table.Builder tableColumns(java.util.List<? extends Column> tableColumns)

(experimental) The columns of the table.

Parameters:

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

Returns:

this

distStyle

public Table.Builder distStyle(TableDistStyle distStyle)

(experimental) The distribution style of the table.

Default: TableDistStyle.AUTO

Parameters:

distStyle - The distribution style of the table. This parameter is required.

Returns:

this

removalPolicy

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

sortStyle

public Table.Builder sortStyle(TableSortStyle sortStyle)

(experimental) The sort style of the table.

Default: TableSortStyle.AUTO if no sort key is specified, TableSortStyle.COMPOUND if a sort key is specified

Parameters:

sortStyle - The sort style of the table. This parameter is required.

Returns:

this

tableName

public Table.Builder tableName(java.lang.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

public Table build()