interface ExternalTableProps ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Alpha.ExternalTableProps
Go	github.com/aws/aws-cdk-go/awscdkgluealpha/v2#ExternalTableProps
Java	software.amazon.awscdk.services.glue.alpha.ExternalTableProps
Python	aws_cdk.aws_glue_alpha.ExternalTableProps
TypeScript (source)	@aws-cdk/aws-glue-alpha » ExternalTableProps

⚠️ Deprecated: undefined

Implements TableBaseProps

Example

declare const myConnection: glue.Connection;
declare const myDatabase: glue.Database;
new glue.ExternalTable(this, 'MyTable', {
  connection: myConnection,
  externalDataLocation: 'default_db_public_example', // A table in Redshift
  // ...
  database: myDatabase,
  columns: [{
    name: 'col1',
    type: glue.Schema.STRING,
  }],
  dataFormat: glue.DataFormat.JSON,
});

Properties

Name	Type	Description
columns⚠️	Column[]	Columns of the table.
connection⚠️	IConnection	The connection the table will use when performing reads and writes.
dataFormat⚠️	DataFormat	Storage type of the table's data.
database⚠️	IDatabase	Database in which to store the table.
externalDataLocation⚠️	string	The data source location of the glue table, (e.g. default_db_public_example for Redshift).
compressed?⚠️	boolean	Indicates whether the table's data is compressed or not.
description?⚠️	string	Description of the table.
enablePartitionFiltering?⚠️	boolean	Enables partition filtering.
hasEncryptedData?⚠️	boolean	Whether the data stored in the table is encrypted.
parameters?⚠️	{ [string]: string }	The key/value pairs define properties associated with the table.
partitionIndexes?⚠️	PartitionIndex[]	Partition indexes on the table.
partitionKeys?⚠️	Column[]	Partition columns of the table.
partitionProjection?⚠️	{ [string]: PartitionProjectionConfiguration }	Partition projection configuration for this table.
storageParameters?⚠️	StorageParameter[]	The user-supplied properties for the description of the physical storage of this table.
storedAsSubDirectories?⚠️	boolean	Indicates whether the table data is stored in subdirectories.
tableName?⚠️	string	Name of the table.

---

columns⚠️

⚠️ Deprecated: undefined

Type: Column[]

Columns of the table.

---

connection⚠️

⚠️ Deprecated: undefined

Type: IConnection

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

---

dataFormat⚠️

⚠️ Deprecated: undefined

Type: DataFormat

Storage type of the table's data.

---

database⚠️

⚠️ Deprecated: undefined

Type: IDatabase

Database in which to store the table.

---

externalDataLocation⚠️

⚠️ Deprecated: undefined

Type: string

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.

---

compressed?⚠️

⚠️ Deprecated: undefined

Type: boolean (optional, default: false)

Indicates whether the table's data is compressed or not.

---

description?⚠️

⚠️ Deprecated: undefined

Type: string (optional, default: generated)

Description of the table.

---

enablePartitionFiltering?⚠️

⚠️ Deprecated: undefined

Type: boolean (optional, default: The parameter is not defined)

Enables partition filtering.

See also: https://docs.aws.amazon.com/athena/latest/ug/glue-best-practices.html#glue-best-practices-partition-index

---

hasEncryptedData?⚠️

⚠️ Deprecated: undefined

Type: boolean (optional, default: true)

Whether the data stored in the table is encrypted.

This sets the has_encrypted_data table parameter. Athena reads it when querying client-side (CSE-KMS) encrypted datasets; for server-side encrypted (SSE-S3 / SSE-KMS) or unencrypted data it has no effect, since Amazon S3 decrypts server-side encrypted objects transparently.

Do not also set has_encrypted_data through parameters - use this property instead. A conflicting value in parameters is rejected.

See also: https://docs.aws.amazon.com/athena/latest/ug/creating-tables-based-on-encrypted-datasets-in-s3.html

---

parameters?⚠️

⚠️ Deprecated: undefined

Type: { [string]: string } (optional, default: The parameter is not defined)

The key/value pairs define properties associated with the table.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

---

partitionIndexes?⚠️

⚠️ Deprecated: undefined

Type: PartitionIndex[] (optional, default: table has no partition indexes)

Partition indexes on the table.

A maximum of 3 indexes are allowed on a table. Keys in the index must be part of the table's partition keys.

---

partitionKeys?⚠️

⚠️ Deprecated: undefined

Type: Column[] (optional, default: table is not partitioned)

Partition columns of the table.

---

partitionProjection?⚠️

⚠️ Deprecated: undefined

Type: { [string]: PartitionProjectionConfiguration } (optional, default: No partition projection)

Partition projection configuration for this table.

Partition projection allows Athena to automatically add new partitions without requiring ALTER TABLE ADD PARTITION statements.

See also: https://docs.aws.amazon.com/athena/latest/ug/partition-projection.html

---

storageParameters?⚠️

⚠️ Deprecated: undefined

Type: StorageParameter[] (optional, default: The parameter is not defined)

The user-supplied properties for the description of the physical storage of this table.

These properties help describe the format of the data that is stored within the crawled data sources.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Some keys will be auto-populated by glue crawlers, however, you can override them by specifying the key and value in this property.

See also: [https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_EXTERNAL_TABLE.html#r_CREATE_EXTERNAL_TABLE-parameters - under "TABLE PROPERTIES"](https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_EXTERNAL_TABLE.html#r_CREATE_EXTERNAL_TABLE-parameters - under "TABLE PROPERTIES") Example

   declare const glueDatabase: glue.IDatabase;
   const table = new glue.S3Table(this, 'Table', {
     storageParameters: [
         glue.StorageParameter.skipHeaderLineCount(1),
         glue.StorageParameter.compressionType(glue.CompressionType.GZIP),
         glue.StorageParameter.custom('foo', 'bar'), // Will have no effect
         glue.StorageParameter.custom('separatorChar', ','), // Will describe the separator char used in the data
         glue.StorageParameter.custom(glue.StorageParameters.WRITE_PARALLEL, 'off'),
     ],
     // ...
     database: glueDatabase,
     columns: [{
         name: 'col1',
         type: glue.Schema.STRING,
     }],
     dataFormat: glue.DataFormat.CSV,
   });

---

storedAsSubDirectories?⚠️

⚠️ Deprecated: undefined

Type: boolean (optional, default: false)

Indicates whether the table data is stored in subdirectories.

---

tableName?⚠️

⚠️ Deprecated: undefined

Type: string (optional, default: generated by CDK.)

Name of the table.