Skip to content
v2.274.0

Experimental

@aws-cdk/aws-redshift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TableProps Struct ​

Properties for configuring a Redshift table.

Example ​

ts
new Table(this, 'Table', {
  tableColumns: [
    { name: 'col1', dataType: 'varchar(4)', distKey: true },
    { name: 'col2', dataType: 'float' },
  ],
  cluster: cluster,
  databaseName: 'databaseName',
  distStyle: TableDistStyle.KEY,
});

Properties ​

adminUserISecretadmin_userISecretadminUserISecretAdminUserISecretAdminUserISecret#
The secret containing credentials to a Redshift user with administrator privileges.

Default: the admin secret is taken from the cluster

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

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#
The cluster containing the database.
databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#
The name of the database.
distStyleTableDistStyledist_styleTableDistStyledistStyleTableDistStyleDistStyleTableDistStyleDistStyleTableDistStyle= TableDistStyle.AUTO#
The distribution style of the table.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= cdk.RemovalPolicy.Retain#
The policy to apply when this resource is removed from the application.
The sort style of the table.

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

tableColumnsColumn[]table_columnstyping.List[Column]tableColumnsList<Column>TableColumnsColumn[]TableColumns*[]Columnrequired#
The columns of the table.
tableCommentstringtable_commentstrtableCommentStringTableCommentstringTableComment*string#
A comment to attach to the table.

Default: no comment

tableNamestringtable_namestrtableNameStringTableNamestringTableName*string#
The name of the table.

Default: a name is generated

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration#
Handler timeout duration.

Default: 1 minute

Valid values are between 1 second and 15 minutes.