Package software.amazon.awscdk.services.redshift.alpha

Interface Column

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
Column.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:11.818Z") @Stability(Experimental) public interface Column extends software.amazon.jsii.JsiiSerializable
(experimental) 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 software.amazon.awscdk.services.redshift.alpha.*;
 Column column = Column.builder()
         .dataType("dataType")
         .name("name")
         // the properties below are optional
         .comment("comment")
         .distKey(false)
         .encoding(ColumnEncoding.AUTO)
         .id("id")
         .sortKey(false)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Column.Builder
    A builder for Column
    static final class 
    Column.Jsii$Proxy
    An implementation for Column

  • Method Summary

    Modifier and Type
    Method
    Description
    static Column.Builder
    builder()
     
    default String
    getComment()
    (experimental) A comment to attach to the column.
    String
    getDataType()
    (experimental) The data type of the column.
    default Boolean
    getDistKey()
    (experimental) Boolean value that indicates whether the column is to be configured as DISTKEY.
    default ColumnEncoding
    getEncoding()
    (experimental) The encoding to use for the column.
    default String
    getId()
    (experimental) The unique identifier of the column.
    String
    getName()
    (experimental) The name of the column.
    default Boolean
    getSortKey()
    (experimental) Boolean value that indicates whether the column is to be configured as SORTKEY.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getDataType

      @Stability(Experimental) @NotNull String getDataType()
      (experimental) The data type of the column.

    • getName

      @Stability(Experimental) @NotNull String getName()
      (experimental) The name of the column.

      This will appear on Amazon Redshift.

    • getComment

      @Stability(Experimental) @Nullable default String getComment()
      (experimental) A comment to attach to the column.

      Default: - no comment

    • getDistKey

      @Stability(Experimental) @Nullable default Boolean getDistKey()
      (experimental) Boolean value that indicates whether the column is to be configured as DISTKEY.

      Default: - column is not DISTKEY

    • getEncoding

      @Stability(Experimental) @Nullable default ColumnEncoding getEncoding()
      (experimental) The encoding to use for the column.

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

    • getId

      @Stability(Experimental) @Nullable default String getId()
      (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

    • getSortKey

      @Stability(Experimental) @Nullable default Boolean getSortKey()
      (experimental) Boolean value that indicates whether the column is to be configured as SORTKEY.

      Default: - column is not a SORTKEY

    • builder

      @Stability(Experimental) static Column.Builder builder()
      Returns:
      a Column.Builder of Column