Package software.amazon.awscdk.services.glue.alpha

Interface ExternalTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TableBaseProps

All Known Implementing Classes:

ExternalTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.760Z")
@Stability(Experimental)
public interface ExternalTableProps
extends software.amazon.jsii.JsiiSerializable, TableBaseProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ExternalTableProps.Builder	builder()
IConnection	getConnection()	(experimental) The connection the table will use when performing reads and writes.
String	getExternalDataLocation()	(experimental) The data source location of the glue table, (e.g.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.glue.alpha.TableBaseProps

getColumns, getCompressed, getDatabase, getDataFormat, getDescription, getEnablePartitionFiltering, getParameters, getPartitionIndexes, getPartitionKeys, getStorageParameters, getStoredAsSubDirectories, getTableName

Method Details

getConnection

@Stability(Experimental)
@NotNull
IConnection getConnection()

(experimental) The connection the table will use when performing reads and writes.

Default: - No connection

getExternalDataLocation

@Stability(Experimental)
@NotNull
String getExternalDataLocation()

(experimental) The data source location of the glue table, (e.g. default_db_public_example for Redshift).

If this property is set, it will override both bucket and s3Prefix.

Default: - No outsourced data source location

builder

@Stability(Experimental)
static ExternalTableProps.Builder builder()

Returns:

a ExternalTableProps.Builder of ExternalTableProps