software.amazon.awscdk.services.glue

Class Table.Builder

java.lang.Object

software.amazon.awscdk.services.glue.Table.Builder

Enclosing class:

Table

public static final class Table.Builder
extends java.lang.Object

(experimental) A fluent builder for Table.

Method Summary

Modifier and Type	Method and Description
Table.Builder	bucket(IBucket bucket) (experimental) S3 bucket in which to store data.
Table	build()
Table.Builder	columns(java.util.List<? extends Column> columns) (experimental) Columns of the table.
Table.Builder	compressed(java.lang.Boolean compressed) (experimental) Indicates whether the table's data is compressed or not.
static Table.Builder	create(software.constructs.Construct scope, java.lang.String id)
Table.Builder	database(IDatabase database) (experimental) Database in which to store the table.
Table.Builder	dataFormat(DataFormat dataFormat) (experimental) Storage type of the table's data.
Table.Builder	description(java.lang.String description) (experimental) Description of the table.
Table.Builder	encryption(TableEncryption encryption) (experimental) The kind of encryption to secure the data with.
Table.Builder	encryptionKey(IKey encryptionKey) (experimental) External KMS key to use for bucket encryption.
Table.Builder	partitionIndexes(java.util.List<? extends PartitionIndex> partitionIndexes) (experimental) Partition indexes on the table.
Table.Builder	partitionKeys(java.util.List<? extends Column> partitionKeys) (experimental) Partition columns of the table.
Table.Builder	s3Prefix(java.lang.String s3Prefix) (experimental) S3 prefix under which table objects are stored.
Table.Builder	storedAsSubDirectories(java.lang.Boolean storedAsSubDirectories) (experimental) Indicates whether the table data is stored in subdirectories.
Table.Builder	tableName(java.lang.String tableName) (experimental) Name of the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Table.Builder create(software.constructs.Construct scope,
                                   java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Table.Builder.

columns

public Table.Builder columns(java.util.List<? extends Column> columns)

(experimental) Columns of the table.

Parameters:

columns - Columns of the table. This parameter is required.

Returns:

this

database

public Table.Builder database(IDatabase database)

(experimental) Database in which to store the table.

Parameters:

database - Database in which to store the table. This parameter is required.

Returns:

this

dataFormat

public Table.Builder dataFormat(DataFormat dataFormat)

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

Parameters:

dataFormat - Storage type of the table's data. This parameter is required.

Returns:

this

tableName

public Table.Builder tableName(java.lang.String tableName)

(experimental) Name of the table.

Parameters:

tableName - Name of the table. This parameter is required.

Returns:

this

bucket

public Table.Builder bucket(IBucket bucket)

(experimental) S3 bucket in which to store data.

Default: one is created for you

Parameters:

bucket - S3 bucket in which to store data. This parameter is required.

Returns:

this

compressed

public Table.Builder compressed(java.lang.Boolean compressed)

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

Default: false

Parameters:

compressed - Indicates whether the table's data is compressed or not. This parameter is required.

Returns:

this

description

public Table.Builder description(java.lang.String description)

(experimental) Description of the table.

Default: generated

Parameters:

description - Description of the table. This parameter is required.

Returns:

this

encryption

public Table.Builder encryption(TableEncryption encryption)

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

Parameters:

encryption - The kind of encryption to secure the data with. This parameter is required.

Returns:

this

encryptionKey

public Table.Builder encryptionKey(IKey encryptionKey)

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

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

Default: key is managed by KMS.

Parameters:

encryptionKey - External KMS key to use for bucket encryption. This parameter is required.

Returns:

this

partitionIndexes

public Table.Builder partitionIndexes(java.util.List<? extends PartitionIndex> partitionIndexes)

(experimental) 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.

Default: table has no partition indexes

Parameters:

partitionIndexes - Partition indexes on the table. This parameter is required.

Returns:

this

partitionKeys

public Table.Builder partitionKeys(java.util.List<? extends Column> partitionKeys)

(experimental) Partition columns of the table.

Default: table is not partitioned

Parameters:

partitionKeys - Partition columns of the table. This parameter is required.

Returns:

this

s3Prefix

public Table.Builder s3Prefix(java.lang.String s3Prefix)

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

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

Parameters:

s3Prefix - S3 prefix under which table objects are stored. This parameter is required.

Returns:

this

storedAsSubDirectories

public Table.Builder storedAsSubDirectories(java.lang.Boolean storedAsSubDirectories)

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

Default: false

Parameters:

storedAsSubDirectories - Indicates whether the table data is stored in subdirectories. This parameter is required.

Returns:

this

build

public Table build()