interface TableProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Redshift.Alpha.TableProps
Go	github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#TableProps
Java	software.amazon.awscdk.services.redshift.alpha.TableProps
Python	aws_cdk.aws_redshift_alpha.TableProps
TypeScript (source)	@aws-cdk/aws-redshift-alpha » TableProps

Properties for configuring a Redshift table.

Example

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

Properties

Name	Type	Description
cluster🔹	ICluster	The cluster containing the database.
databaseName🔹	string	The name of the database.
tableColumns🔹	Column[]	The columns of the table.
adminUser?🔹	ISecret	The secret containing credentials to a Redshift user with administrator privileges.
distStyle?🔹	TableDistStyle	The distribution style of the table.
removalPolicy?🔹	RemovalPolicy	The policy to apply when this resource is removed from the application.
sortStyle?🔹	TableSortStyle	The sort style of the table.
tableComment?🔹	string	A comment to attach to the table.
tableName?🔹	string	The name of the table.
timeout?🔹	Duration	Handler timeout duration.

---

cluster🔹

Type: ICluster

The cluster containing the database.

---

databaseName🔹

Type: string

The name of the database.

---

tableColumns🔹

Type: Column[]

The columns of the table.

---

adminUser?🔹

Type: ISecret (optional, default: the admin secret is taken from the cluster)

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

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

---

distStyle?🔹

Type: TableDistStyle (optional, default: TableDistStyle.AUTO)

The distribution style of the table.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: cdk.RemovalPolicy.Retain)

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

---

sortStyle?🔹

Type: TableSortStyle (optional, default: TableSortStyle.AUTO if no sort key is specified, TableSortStyle.COMPOUND if a sort key is specified)

The sort style of the table.

---

tableComment?🔹

Type: string (optional, default: no comment)

A comment to attach to the table.

---

tableName?🔹

Type: string (optional, default: a name is generated)

The name of the table.

---

timeout?🔹

Type: Duration (optional, default: 1 minute)

Handler timeout duration.

Valid values are between 1 second and 15 minutes.