Column

class aws_cdk.aws_redshift_alpha.Column(*, data_type, name, comment=None, dist_key=None, encoding=None, id=None, sort_key=None)

Bases: object

(experimental) A column in a Redshift table.

Parameters:

  • data_type (str) – (experimental) The data type of the column.

  • name (str) – (experimental) The name of the column. This will appear on Amazon Redshift.

  • comment (Optional[str]) – (experimental) A comment to attach to the column. Default: - no comment

  • dist_key (Optional[bool]) – (experimental) Boolean value that indicates whether the column is to be configured as DISTKEY. Default: - column is not DISTKEY

  • encoding (Optional[ColumnEncoding]) – (experimental) The encoding to use for the column. Default: - Amazon Redshift determines the encoding based on the data type.

  • id (Optional[str]) – (experimental) 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. Default: - the column name is used as the identifier

  • sort_key (Optional[bool]) – (experimental) Boolean value that indicates whether the column is to be configured as SORTKEY. Default: - column is not a SORTKEY

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift_alpha as redshift_alpha

column = redshift_alpha.Column(
    data_type="dataType",
    name="name",

    # the properties below are optional
    comment="comment",
    dist_key=False,
    encoding=redshift_alpha.ColumnEncoding.AUTO,
    id="id",
    sort_key=False
)

Attributes

comment

(experimental) A comment to attach to the column.

Default:

  • no comment

Stability:

experimental

data_type

(experimental) The data type of the column.

Stability:

experimental

dist_key

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

Default:

  • column is not DISTKEY

Stability:

experimental

encoding

(experimental) The encoding to use for the column.

Default:

  • Amazon Redshift determines the encoding based on the data type.

Stability:

experimental

id

(experimental) 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.

Default:

  • the column name is used as the identifier

Stability:

experimental

name

(experimental) The name of the column.

This will appear on Amazon Redshift.

Stability:

experimental

sort_key

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

Default:

  • column is not a SORTKEY

Stability:

experimental