Package software.amazon.awscdk.services.redshift

Class Table

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.services.redshift.Table
All Implemented Interfaces:
IConstruct, IDependable, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.852Z") @Stability(Experimental) public class Table extends Construct implements ITable
(experimental) A table in a Redshift cluster.

Example: 

 Table.Builder.create(this, "Table")
         .tableColumns(List.of(Column.builder().name("col1").dataType("varchar(4)").distKey(true).build(), Column.builder().name("col2").dataType("float").build()))
         .cluster(cluster)
         .databaseName("databaseName")
         .distStyle(TableDistStyle.KEY)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Table.Builder
    (experimental) A fluent builder for Table.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

    IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.redshift.ITable

    ITable.Jsii$Default, ITable.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Table(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Table(software.constructs.Construct scope, String id, TableProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyRemovalPolicy(RemovalPolicy policy)
    (experimental) Apply the given removal policy to this resource.
    static ITable
    fromTableAttributes(software.constructs.Construct scope, String id, TableAttributes attrs)
    (experimental) Specify a Redshift table using a table name and schema that already exists.
    ICluster
    getCluster()
    (experimental) The cluster where the table is located.
    String
    getDatabaseName()
    (experimental) The name of the database where the table is located.
    List<Column>
    getTableColumns()
    (experimental) The columns of the table.
    String
    getTableName()
    (experimental) Name of the table.
    void
    grant(IUser user, @NotNull TableAction... actions)
    (experimental) Grant a user privilege to access this table.

    Methods inherited from class software.amazon.awscdk.core.Construct

    getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

    Methods inherited from class software.constructs.Construct

    toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awscdk.core.IConstruct

    getNode

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Table

      protected Table(software.amazon.jsii.JsiiObjectRef objRef)

    • Table

      protected Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Table

      @Stability(Experimental) public Table(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TableProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromTableAttributes

      @Stability(Experimental) @NotNull public static ITable fromTableAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TableAttributes attrs)
      (experimental) Specify a Redshift table using a table name and schema that already exists.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • applyRemovalPolicy

      @Stability(Experimental) public void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      (experimental) Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be destroyed (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      This resource is retained by default.

      Parameters:
      policy - This parameter is required.

    • grant

      @Stability(Experimental) public void grant(@NotNull IUser user, @NotNull @NotNull TableAction... actions)
      (experimental) Grant a user privilege to access this table.

      Specified by:
      grant in interface ITable
      Parameters:
      user - This parameter is required.
      actions - This parameter is required.

    • getCluster

      @Stability(Experimental) @NotNull public ICluster getCluster()
      (experimental) The cluster where the table is located.
      Specified by:
      getCluster in interface ITable

    • getDatabaseName

      @Stability(Experimental) @NotNull public String getDatabaseName()
      (experimental) The name of the database where the table is located.
      Specified by:
      getDatabaseName in interface ITable

    • getTableColumns

      @Stability(Experimental) @NotNull public List<Column> getTableColumns()
      (experimental) The columns of the table.
      Specified by:
      getTableColumns in interface ITable

    • getTableName

      @Stability(Experimental) @NotNull public String getTableName()
      (experimental) Name of the table.
      Specified by:
      getTableName in interface ITable