@aws-cdk_aws-redshift-alpha.Column

interface Column ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.Column
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#Column
Javasoftware.amazon.awscdk.services.redshift.alpha.Column
Pythonaws_cdk.aws_redshift_alpha.Column
TypeScript (source)@aws-cdk/aws-redshift-alpha ยป Column

A column in a Redshift table.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';
const column: redshift_alpha.Column = {
  dataType: 'dataType',
  name: 'name',

  // the properties below are optional
  comment: 'comment',
  distKey: false,
  encoding: redshift_alpha.ColumnEncoding.AUTO,
  id: 'id',
  sortKey: false,
};

Properties

NameTypeDescription
dataType๐Ÿ”นstringThe data type of the column.
name๐Ÿ”นstringThe name of the column.
comment?๐Ÿ”นstringA comment to attach to the column.
distKey?๐Ÿ”นbooleanBoolean value that indicates whether the column is to be configured as DISTKEY.
encoding?๐Ÿ”นColumnEncodingThe encoding to use for the column.
id?๐Ÿ”นstringThe unique identifier of the column.
sortKey?๐Ÿ”นbooleanBoolean value that indicates whether the column is to be configured as SORTKEY.

dataType๐Ÿ”น

Type: string

The data type of the column.


name๐Ÿ”น

Type: string

The name of the column.

This will appear on Amazon Redshift.


comment?๐Ÿ”น

Type: string (optional, default: no comment)

A comment to attach to the column.


distKey?๐Ÿ”น

Type: boolean (optional, default: column is not DISTKEY)

Boolean value that indicates whether the column is to be configured as DISTKEY.


encoding?๐Ÿ”น

Type: ColumnEncoding (optional, default: Amazon Redshift determines the encoding based on the data type.)

The encoding to use for the column.


id?๐Ÿ”น

Type: string (optional, default: the column name is used as the identifier)

The unique identifier of the column.

This is not the name of the column, and renaming this identifier will cause a new column to be created and the old column to be dropped.

NOTE - This field will be set, however, only by setting the @aws-cdk/aws-redshift:columnId feature flag will this field be used.


sortKey?๐Ÿ”น

Type: boolean (optional, default: column is not a SORTKEY)

Boolean value that indicates whether the column is to be configured as SORTKEY.