Package software.amazon.awscdk.services.s3tables.alpha

Class Table.Builder

java.lang.Object

software.amazon.awscdk.services.s3tables.alpha.Table.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Table>

Enclosing class:

Table

@Stability(Experimental)
public static final class Table.Builder
extends Object
implements software.amazon.jsii.Builder<Table>

(experimental) A fluent builder for Table.

Method Summary

Modifier and Type	Method	Description
Table	build()
Table.Builder	compaction(CompactionProperty compaction)	(experimental) Settings governing the Compaction maintenance action.
static Table.Builder	create(software.constructs.Construct scope, String id)
Table.Builder	icebergMetadata(IcebergMetadataProperty icebergMetadata)	(experimental) Contains details about the metadata for an Iceberg table.
Table.Builder	namespace(INamespace namespace)	(experimental) The namespace under which this table is created.
Table.Builder	openTableFormat(OpenTableFormat openTableFormat)	(experimental) Format of this table.
Table.Builder	removalPolicy(RemovalPolicy removalPolicy)	(experimental) Controls what happens to this table it it stoped being managed by cloudformation.
Table.Builder	snapshotManagement(SnapshotManagementProperty snapshotManagement)	(experimental) Contains details about the snapshot management settings for an Iceberg table.
Table.Builder	tableName(String tableName)	(experimental) Name of this table, unique within the namespace.
Table.Builder	withoutMetadata(Boolean withoutMetadata)	(experimental) If true, indicates that you don't want to specify a schema for the table.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static Table.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Table.Builder.

namespace

@Stability(Experimental)
public Table.Builder namespace(INamespace namespace)

(experimental) The namespace under which this table is created.

Parameters:

namespace - The namespace under which this table is created. This parameter is required.

Returns:

this

openTableFormat

@Stability(Experimental)
public Table.Builder openTableFormat(OpenTableFormat openTableFormat)

(experimental) Format of this table.

Currently, the only supported value is OpenTableFormat.ICEBERG.

Parameters:

openTableFormat - Format of this table. This parameter is required.

Returns:

this

tableName

@Stability(Experimental)
public Table.Builder tableName(String tableName)

(experimental) Name of this table, unique within the namespace.

Parameters:

tableName - Name of this table, unique within the namespace. This parameter is required.

Returns:

this

compaction

@Stability(Experimental)
public Table.Builder compaction(CompactionProperty compaction)

(experimental) Settings governing the Compaction maintenance action.

Default: Amazon S3 selects the best compaction strategy based on your table sort order.

Parameters:

compaction - Settings governing the Compaction maintenance action. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html

icebergMetadata

@Stability(Experimental)
public Table.Builder icebergMetadata(IcebergMetadataProperty icebergMetadata)

(experimental) Contains details about the metadata for an Iceberg table.

Default: table is created without any metadata

Parameters:

icebergMetadata - Contains details about the metadata for an Iceberg table. This parameter is required.

Returns:

this

removalPolicy

@Stability(Experimental)
public Table.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) Controls what happens to this table it it stoped being managed by cloudformation.

Default: RETAIN

Parameters:

removalPolicy - Controls what happens to this table it it stoped being managed by cloudformation. This parameter is required.

Returns:

this

snapshotManagement

@Stability(Experimental)
public Table.Builder snapshotManagement(SnapshotManagementProperty snapshotManagement)

(experimental) Contains details about the snapshot management settings for an Iceberg table.

Default: enabled: MinimumSnapshots is 1 by default and MaximumSnapshotAge is 120 hours by default.

Parameters:

snapshotManagement - Contains details about the snapshot management settings for an Iceberg table. This parameter is required.

Returns:

this

withoutMetadata

@Stability(Experimental)
public Table.Builder withoutMetadata(Boolean withoutMetadata)

(experimental) If true, indicates that you don't want to specify a schema for the table.

This property is mutually exclusive to 'IcebergMetadata'.

Default: false

Parameters:

withoutMetadata - If true, indicates that you don't want to specify a schema for the table. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public Table build()

Specified by:

build in interface software.amazon.jsii.Builder<Table>

Returns:

a newly built instance of Table.