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.
|
public static Table.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.Table.Builder
.public Table.Builder columns(java.util.List<? extends Column> columns)
columns
- Columns of the table. This parameter is required.this
public Table.Builder database(IDatabase database)
database
- Database in which to store the table. This parameter is required.this
public Table.Builder dataFormat(DataFormat dataFormat)
dataFormat
- Storage type of the table's data. This parameter is required.this
public Table.Builder tableName(java.lang.String tableName)
tableName
- Name of the table. This parameter is required.this
public Table.Builder bucket(IBucket bucket)
Default: one is created for you
bucket
- S3 bucket in which to store data. This parameter is required.this
public Table.Builder compressed(java.lang.Boolean compressed)
Default: false
compressed
- Indicates whether the table's data is compressed or not. This parameter is required.this
public Table.Builder description(java.lang.String description)
Default: generated
description
- Description of the table. This parameter is required.this
public Table.Builder encryption(TableEncryption encryption)
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
- The kind of encryption to secure the data with. This parameter is required.this
public Table.Builder encryptionKey(IKey encryptionKey)
The encryption
property must be SSE-KMS
or CSE-KMS
.
Default: key is managed by KMS.
encryptionKey
- External KMS key to use for bucket encryption. This parameter is required.this
public Table.Builder partitionIndexes(java.util.List<? extends PartitionIndex> partitionIndexes)
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
partitionIndexes
- Partition indexes on the table. This parameter is required.this
public Table.Builder partitionKeys(java.util.List<? extends Column> partitionKeys)
Default: table is not partitioned
partitionKeys
- Partition columns of the table. This parameter is required.this
public Table.Builder s3Prefix(java.lang.String s3Prefix)
Default: - No prefix. The data will be stored under the root of the bucket.
s3Prefix
- S3 prefix under which table objects are stored. This parameter is required.this
public Table.Builder storedAsSubDirectories(java.lang.Boolean storedAsSubDirectories)
Default: false
storedAsSubDirectories
- Indicates whether the table data is stored in subdirectories. This parameter is required.this
public Table build()