TableProps¶

class aws_cdk.aws_glue.TableProps(*, columns, database, data_format, table_name, bucket=None, compressed=None, description=None, encryption=None, encryption_key=None, partition_keys=None, s3_prefix=None, stored_as_sub_directories=None)¶

Bases: object

__init__(*, columns, database, data_format, table_name, bucket=None, compressed=None, description=None, encryption=None, encryption_key=None, partition_keys=None, s3_prefix=None, stored_as_sub_directories=None)¶

Parameters

columns (List[Column]) – Columns of the table.
database (IDatabase) – Database in which to store the table.
data_format (DataFormat) – Storage type of the table’s data.
table_name (str) – Name of the table.
bucket (Optional[IBucket]) – S3 bucket in which to store data. Default: one is created for you
compressed (Optional[bool]) – Indicates whether the table’s data is compressed or not. Default: false
description (Optional[str]) – Description of the table. Default: generated
encryption (Optional[TableEncryption]) – 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. Default: Unencrypted
encryption_key (Optional[IKey]) – External KMS key to use for bucket encryption. The encryption property must be SSE-KMS or CSE-KMS. Default: key is managed by KMS.
partition_keys (Optional[List[Column]]) – Partition columns of the table. Default: table is not partitioned
s3_prefix (Optional[str]) – S3 prefix under which table objects are stored. Default: - No prefix. The data will be stored under the root of the bucket.
stored_as_sub_directories (Optional[bool]) – Indicates whether the table data is stored in subdirectories. Default: false

stability :stability: experimental

Return type: None

Attributes

bucket¶

S3 bucket in which to store data.

default :default: one is created for you

stability :stability: experimental

Return type: Optional[IBucket]

columns¶

Columns of the table.

stability :stability: experimental

Return type: List[Column]

compressed¶

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

default :default: false

stability :stability: experimental

Return type: Optional[bool]

data_format¶

Storage type of the table’s data.

stability :stability: experimental

Return type: DataFormat

database¶

Database in which to store the table.

stability :stability: experimental

Return type: IDatabase

description¶

Description of the table.

default :default: generated

stability :stability: experimental

Return type: Optional[str]

encryption¶

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.

default :default: Unencrypted

stability :stability: experimental

Return type: Optional[TableEncryption]

encryption_key¶

External KMS key to use for bucket encryption.

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

default :default: key is managed by KMS.

stability :stability: experimental

Return type: Optional[IKey]

partition_keys¶

Partition columns of the table.

default :default: table is not partitioned

stability :stability: experimental

Return type: Optional[List[Column]]

s3_prefix¶

S3 prefix under which table objects are stored.

default :default: - No prefix. The data will be stored under the root of the bucket.

stability :stability: experimental

Return type: Optional[str]

stored_as_sub_directories¶

Indicates whether the table data is stored in subdirectories.

default :default: false

stability :stability: experimental

Return type: Optional[bool]

table_name¶

Name of the table.

stability :stability: experimental

Return type: str