@aws-cdk_aws-glue-alpha.TableProps

interface TableProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Glue.Alpha.TableProps
Gogithub.com/aws/aws-cdk-go/awscdkgluealpha/v2#TableProps
Javasoftware.amazon.awscdk.services.glue.alpha.TableProps
Pythonaws_cdk.aws_glue_alpha.TableProps
TypeScript (source)@aws-cdk/aws-glue-alpha ยป TableProps

Example

declare const myDatabase: glue.Database;
new glue.Table(this, 'MyTable', {
  database: myDatabase,
  columns: [{
    name: 'col1',
    type: glue.Schema.STRING,
  }],
  partitionKeys: [{
    name: 'year',
    type: glue.Schema.SMALL_INT,
  }, {
    name: 'month',
    type: glue.Schema.SMALL_INT,
  }],
  dataFormat: glue.DataFormat.JSON,
});

Properties

NameTypeDescription
columns๐Ÿ”นColumn[]Columns of the table.
dataFormat๐Ÿ”นDataFormatStorage type of the table's data.
database๐Ÿ”นIDatabaseDatabase in which to store the table.
bucket?๐Ÿ”นIBucketS3 bucket in which to store data.
compressed?๐Ÿ”นbooleanIndicates whether the table's data is compressed or not.
description?๐Ÿ”นstringDescription of the table.
enablePartitionFiltering?๐Ÿ”นbooleanEnables partition filtering.
encryption?๐Ÿ”นTableEncryptionThe kind of encryption to secure the data with.
encryptionKey?๐Ÿ”นIKeyExternal KMS key to use for bucket encryption.
partitionIndexes?๐Ÿ”นPartitionIndex[]Partition indexes on the table.
partitionKeys?๐Ÿ”นColumn[]Partition columns of the table.
s3Prefix?๐Ÿ”นstringS3 prefix under which table objects are stored.
storedAsSubDirectories?๐Ÿ”นbooleanIndicates whether the table data is stored in subdirectories.
tableName?๐Ÿ”นstringName of the table.

columns๐Ÿ”น

Type: Column[]

Columns of the table.


dataFormat๐Ÿ”น

Type: DataFormat

Storage type of the table's data.


database๐Ÿ”น

Type: IDatabase

Database in which to store the table.


bucket?๐Ÿ”น

Type: IBucket (optional, default: one is created for you)

S3 bucket in which to store data.


compressed?๐Ÿ”น

Type: boolean (optional, default: false)

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


description?๐Ÿ”น

Type: string (optional, default: generated)

Description of the table.


enablePartitionFiltering?๐Ÿ”น

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


encryption?๐Ÿ”น

Type: TableEncryption (optional, default: BucketEncryption.S3_MANAGED)

The kind of encryption to secure the data with.

You can only provide this option if you are not explicitly passing in a bucket.

If you choose SSE-KMS, you can provide an un-managed KMS key with encryptionKey. If you choose CSE-KMS, you must provide an un-managed KMS key with encryptionKey.


encryptionKey?๐Ÿ”น

Type: IKey (optional, default: key is managed by KMS.)

External KMS key to use for bucket encryption.

The encryption property must be SSE-KMS or CSE-KMS.


partitionIndexes?๐Ÿ”น

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?๐Ÿ”น

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

Partition columns of the table.


s3Prefix?๐Ÿ”น

Type: string (optional, default: No prefix. The data will be stored under the root of the bucket.)

S3 prefix under which table objects are stored.


storedAsSubDirectories?๐Ÿ”น

Type: boolean (optional, default: false)

Indicates whether the table data is stored in subdirectories.


tableName?๐Ÿ”น

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

Name of the table.