@aws-cdk_aws-redshift-alpha.TableProps

interface TableProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.TableProps
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#TableProps
Javasoftware.amazon.awscdk.services.redshift.alpha.TableProps
Pythonaws_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

NameTypeDescription
cluster๐Ÿ”นIClusterThe cluster containing the database.
databaseName๐Ÿ”นstringThe name of the database.
tableColumns๐Ÿ”นColumn[]The columns of the table.
adminUser?๐Ÿ”นISecretThe secret containing credentials to a Redshift user with administrator privileges.
distStyle?๐Ÿ”นTableDistStyleThe distribution style of the table.
removalPolicy?๐Ÿ”นRemovalPolicyThe policy to apply when this resource is removed from the application.
sortStyle?๐Ÿ”นTableSortStyleThe sort style of the table.
tableComment?๐Ÿ”นstringA comment to attach to the table.
tableName?๐Ÿ”นstringThe name of the table.

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.