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

Class TableProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<TableProps>

Enclosing interface:

TableProps

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

A builder for TableProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TableProps	build()	Builds the configured instance.
TableProps.Builder	compaction(CompactionProperty compaction)	Sets the value of TableProps.getCompaction()
TableProps.Builder	icebergMetadata(IcebergMetadataProperty icebergMetadata)	Sets the value of TableProps.getIcebergMetadata()
TableProps.Builder	namespace(INamespace namespace)	Sets the value of TableProps.getNamespace()
TableProps.Builder	openTableFormat(OpenTableFormat openTableFormat)	Sets the value of TableProps.getOpenTableFormat()
TableProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of TableProps.getRemovalPolicy()
TableProps.Builder	snapshotManagement(SnapshotManagementProperty snapshotManagement)	Sets the value of TableProps.getSnapshotManagement()
TableProps.Builder	tableName(String tableName)	Sets the value of TableProps.getTableName()
TableProps.Builder	withoutMetadata(Boolean withoutMetadata)	Sets the value of TableProps.getWithoutMetadata()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

namespace

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

Sets the value of TableProps.getNamespace()

Parameters:

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

Returns:

this

openTableFormat

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

Sets the value of TableProps.getOpenTableFormat()

Parameters:

openTableFormat - Format of this table. This parameter is required. Currently, the only supported value is OpenTableFormat.ICEBERG.

Returns:

this

tableName

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

Sets the value of TableProps.getTableName()

Parameters:

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

Returns:

this

compaction

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

Sets the value of TableProps.getCompaction()

Parameters:

compaction - Settings governing the Compaction maintenance action.

Returns:

this

icebergMetadata

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

Sets the value of TableProps.getIcebergMetadata()

Parameters:

icebergMetadata - Contains details about the metadata for an Iceberg table.

Returns:

this

removalPolicy

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

Sets the value of TableProps.getRemovalPolicy()

Parameters:

removalPolicy - Controls what happens to this table it it stoped being managed by cloudformation.

Returns:

this

snapshotManagement

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

Sets the value of TableProps.getSnapshotManagement()

Parameters:

snapshotManagement - Contains details about the snapshot management settings for an Iceberg table.

Returns:

this

withoutMetadata

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

Sets the value of TableProps.getWithoutMetadata()

Parameters:

withoutMetadata - If true, indicates that you don't want to specify a schema for the table. This property is mutually exclusive to 'IcebergMetadata'.

Returns:

this

build

@Stability(Experimental)
public TableProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TableProps

Throws:

NullPointerException - if any required attribute was not provided