Class ExternalTable

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.glue.alpha.TableBase
software.amazon.awscdk.services.glue.alpha.ExternalTable
All Implemented Interfaces:
IResource, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-10-31T19:13:07.888Z") @Stability(Experimental) public class ExternalTable extends TableBase
(experimental) A Glue table that targets an external data location (e.g. A table in a Redshift Cluster).

Example:

 Connection myConnection;
 Database myDatabase;
 ExternalTable.Builder.create(this, "MyTable")
         .connection(myConnection)
         .externalDataLocation("default_db_public_example") // A table in Redshift
         // ...
         .database(myDatabase)
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build()))
         .dataFormat(DataFormat.JSON)
         .build();
 
  • Constructor Details

    • ExternalTable

      protected ExternalTable(software.amazon.jsii.JsiiObjectRef objRef)
    • ExternalTable

      protected ExternalTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • ExternalTable

      @Stability(Experimental) public ExternalTable(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ExternalTableProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • grantRead

      @Stability(Experimental) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
      (experimental) Grant read permissions to the table.

      Specified by:
      grantRead in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.
    • grantReadWrite

      @Stability(Experimental) @NotNull public Grant grantReadWrite(@NotNull IGrantable grantee)
      (experimental) Grant read and write permissions to the table.

      Specified by:
      grantReadWrite in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.
    • grantWrite

      @Stability(Experimental) @NotNull public Grant grantWrite(@NotNull IGrantable grantee)
      (experimental) Grant write permissions to the table.

      Specified by:
      grantWrite in class TableBase
      Parameters:
      grantee - the principal. This parameter is required.
    • getConnection

      @Stability(Experimental) @NotNull public IConnection getConnection()
      (experimental) The connection associated to this table.
    • getTableArn

      @Stability(Experimental) @NotNull public String getTableArn()
      (experimental) ARN of this table.
      Specified by:
      getTableArn in interface ITable
      Specified by:
      getTableArn in class TableBase
    • getTableName

      @Stability(Experimental) @NotNull public String getTableName()
      (experimental) Name of this table.
      Specified by:
      getTableName in interface ITable
      Specified by:
      getTableName in class TableBase
    • getTableResource

      @Stability(Experimental) @NotNull protected CfnTable getTableResource()
      Specified by:
      getTableResource in class TableBase
    • getPartitionIndexes

      @Stability(Experimental) @Nullable public List<PartitionIndex> getPartitionIndexes()
      (experimental) This table's partition indexes.
      Specified by:
      getPartitionIndexes in class TableBase