Class TableProps

Inheritance

System.Object

TableProps

Implements

Namespace: Amazon.CDK.AWS.Glue

Assembly: Amazon.CDK.AWS.Glue.dll

Syntax (csharp)

public class TableProps : Object, ITableProps

Syntax (vb)

Public Class TableProps
    Inherits Object
    Implements ITableProps

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

Database myDatabase;

new Table(this, "MyTable", new TableProps {
    Database = myDatabase,
    TableName = "my_table",
    Columns = new [] { new Column {
        Name = "col1",
        Type = Schema.STRING
    } },
    PartitionKeys = new [] { new Column {
        Name = "year",
        Type = Schema.SMALL_INT
    }, new Column {
        Name = "month",
        Type = Schema.SMALL_INT
    } },
    DataFormat = DataFormat.JSON
});

Synopsis

Constructors

TableProps()

Properties

Bucket	(experimental) S3 bucket in which to store data.
Columns	(experimental) Columns of the table.
Compressed	(experimental) Indicates whether the table's data is compressed or not.
Database	(experimental) Database in which to store the table.
DataFormat	(experimental) Storage type of the table's data.
Description	(experimental) Description of the table.
Encryption	(experimental) The kind of encryption to secure the data with.
EncryptionKey	(experimental) External KMS key to use for bucket encryption.
PartitionIndexes	(experimental) Partition indexes on the table.
PartitionKeys	(experimental) Partition columns of the table.
S3Prefix	(experimental) S3 prefix under which table objects are stored.
StoredAsSubDirectories	(experimental) Indicates whether the table data is stored in subdirectories.
TableName	(experimental) Name of the table.

Constructors

TableProps()

public TableProps()

Properties

Bucket

(experimental) S3 bucket in which to store data.

public IBucket Bucket { get; set; }

Property Value

IBucket

Remarks

Default: one is created for you

Stability: Experimental

Columns

(experimental) Columns of the table.

public IColumn[] Columns { get; set; }

Property Value

IColumn[]

Remarks

Stability: Experimental

Compressed

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

public Nullable<bool> Compressed { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Stability: Experimental

Database

(experimental) Database in which to store the table.

public IDatabase Database { get; set; }

Property Value

IDatabase

Remarks

Stability: Experimental

DataFormat

(experimental) Storage type of the table's data.

public DataFormat DataFormat { get; set; }

Property Value

DataFormat

Remarks

Stability: Experimental

Description

(experimental) Description of the table.

public string Description { get; set; }

Property Value

System.String

Remarks

Default: generated

Stability: Experimental

Encryption

(experimental) The kind of encryption to secure the data with.

public Nullable<TableEncryption> Encryption { get; set; }

Property Value

System.Nullable<TableEncryption>

Remarks

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

Stability: Experimental

EncryptionKey

(experimental) External KMS key to use for bucket encryption.

public IKey EncryptionKey { get; set; }

Property Value

IKey

Remarks

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

Default: key is managed by KMS.

Stability: Experimental

PartitionIndexes

(experimental) Partition indexes on the table.

public IPartitionIndex[] PartitionIndexes { get; set; }

Property Value

IPartitionIndex[]

Remarks

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

Default: table has no partition indexes

Stability: Experimental

PartitionKeys

(experimental) Partition columns of the table.

public IColumn[] PartitionKeys { get; set; }

Property Value

IColumn[]

Remarks

Default: table is not partitioned

Stability: Experimental

S3Prefix

(experimental) S3 prefix under which table objects are stored.

public string S3Prefix { get; set; }

Property Value

System.String

Remarks

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

Stability: Experimental

StoredAsSubDirectories

(experimental) Indicates whether the table data is stored in subdirectories.

public Nullable<bool> StoredAsSubDirectories { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Stability: Experimental

TableName

(experimental) Name of the table.

public string TableName { get; set; }

Property Value

System.String

Remarks

Stability: Experimental

Implements

ITableProps