@aws-cdk/aws-redshift-alpha.Column

Experimental

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

Column Struct

A column in a Redshift table.

Stability

Experimental

Source

lib/table.ts

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

commentstringcommentstrcommentStringCommentstringComment*string= no comment#

A comment to attach to the column.

dataTypestringdata_typestrdataTypeStringDataTypestringDataType*stringrequired#

The data type of the column.

distKeybooleandist_keybooldistKeyBooleanDistKeyboolDistKey*bool= column is not DISTKEY#

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

encodingColumnEncodingencodingColumnEncodingencodingColumnEncodingEncodingColumnEncodingEncodingColumnEncoding= Amazon Redshift determines the e…#

The encoding to use for the column.

default

Default: Amazon Redshift determines the encoding based on the data type.

idstringidstridStringIdstringId*string= the column name is used as the i…#

The unique identifier of the column.

notes · default

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.

Default: the column name is used as the identifier

namestringnamestrnameStringNamestringName*stringrequired#

The name of the column.

This will appear on Amazon Redshift.

sortKeybooleansort_keyboolsortKeyBooleanSortKeyboolSortKey*bool= column is not a SORTKEY#

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