Class Column

(experimental) A column in a Redshift table.

Inheritance
object
Column
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift.Alpha
Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll
Syntax (csharp)
public class Column : IColumn
Syntax (vb)
Public Class Column Implements IColumn
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Redshift.Alpha;

             var column = new Column {
                 DataType = "dataType",
                 Name = "name",

                 // the properties below are optional
                 Comment = "comment",
                 DistKey = false,
                 Encoding = ColumnEncoding.AUTO,
                 Id = "id",
                 SortKey = false
             };

Synopsis

Constructors

Column()

(experimental) A column in a Redshift table.

Properties

Comment

(experimental) A comment to attach to the column.
DataType

(experimental) The data type of the column.
DistKey

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

(experimental) The encoding to use for the column.
Id

(experimental) The unique identifier of the column.
Name

(experimental) The name of the column.
SortKey

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

Constructors

Column()

(experimental) A column in a Redshift table.

public Column()
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Redshift.Alpha;

             var column = new Column {
                 DataType = "dataType",
                 Name = "name",

                 // the properties below are optional
                 Comment = "comment",
                 DistKey = false,
                 Encoding = ColumnEncoding.AUTO,
                 Id = "id",
                 SortKey = false
             };

Properties

Comment

(experimental) A comment to attach to the column.

public string? Comment { get; set; }
Property Value

string

Remarks

Default: - no comment

Stability: Experimental

DataType

(experimental) The data type of the column.

public string DataType { get; set; }
Property Value

string

Remarks

Stability: Experimental

DistKey

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

public bool? DistKey { get; set; }
Property Value

bool?

Remarks

Default: - column is not DISTKEY

Stability: Experimental

Encoding

(experimental) The encoding to use for the column.

public ColumnEncoding? Encoding { get; set; }
Property Value

ColumnEncoding?

Remarks

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

Stability: Experimental

Id

(experimental) The unique identifier of the column.

public string? Id { get; set; }
Property Value

string

Remarks

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.

public string Name { get; set; }
Property Value

string

Remarks

This will appear on Amazon Redshift.

Stability: Experimental

SortKey

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

public bool? SortKey { get; set; }
Property Value

bool?

Remarks

Default: - column is not a SORTKEY

Stability: Experimental

Implements