Package software.amazon.awscdk.services.s3tables

Interface CfnTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:44.750Z")
@Stability(Stable)
public interface CfnTableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTable.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3tables.*;
 CfnTableProps cfnTableProps = CfnTableProps.builder()
         .namespace("namespace")
         .openTableFormat("openTableFormat")
         .tableBucketArn("tableBucketArn")
         .tableName("tableName")
         // the properties below are optional
         .compaction(CompactionProperty.builder()
                 .status("status")
                 .targetFileSizeMb(123)
                 .build())
         .icebergMetadata(IcebergMetadataProperty.builder()
                 .icebergSchema(IcebergSchemaProperty.builder()
                         .schemaFieldList(List.of(SchemaFieldProperty.builder()
                                 .name("name")
                                 .type("type")
                                 // the properties below are optional
                                 .required(false)
                                 .build()))
                         .build())
                 .build())
         .snapshotManagement(SnapshotManagementProperty.builder()
                 .maxSnapshotAgeHours(123)
                 .minSnapshotsToKeep(123)
                 .status("status")
                 .build())
         .storageClassConfiguration(StorageClassConfigurationProperty.builder()
                 .storageClass("storageClass")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .withoutMetadata("withoutMetadata")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTableProps.Builder	A builder for CfnTableProps
static final class	CfnTableProps.Jsii$Proxy	An implementation for CfnTableProps

Method Summary

Modifier and Type	Method	Description
static CfnTableProps.Builder	builder()
default Object	getCompaction()	Contains details about the compaction settings for an Iceberg table.
default Object	getIcebergMetadata()	Contains details about the metadata for an Iceberg table.
String	getNamespace()	The name of the namespace.
String	getOpenTableFormat()	The format of the table.
default Object	getSnapshotManagement()	Contains details about the Iceberg snapshot management settings for the table.
default Object	getStorageClassConfiguration()	Specifies storage class settings for the table.
String	getTableBucketArn()	The Amazon Resource Name (ARN) of the table bucket to create the table in.
String	getTableName()	The name for the table.
default List<CfnTag>	getTags()	User tags (key-value pairs) to associate with the table.
default String	getWithoutMetadata()	Indicates that you don't want to specify a schema for the table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

The name of the namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-namespace

getOpenTableFormat

@Stability(Stable)
@NotNull
String getOpenTableFormat()

The format of the table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-opentableformat

getTableBucketArn

@Stability(Stable)
@NotNull
String getTableBucketArn()

The Amazon Resource Name (ARN) of the table bucket to create the table in.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablebucketarn

getTableName

@Stability(Stable)
@NotNull
String getTableName()

The name for the table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablename

getCompaction

@Stability(Stable)
@Nullable
default Object getCompaction()

Contains details about the compaction settings for an Iceberg table.

Returns union: either IResolvable or CfnTable.CompactionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-compaction

getIcebergMetadata

@Stability(Stable)
@Nullable
default Object getIcebergMetadata()

Contains details about the metadata for an Iceberg table.

Returns union: either IResolvable or CfnTable.IcebergMetadataProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-icebergmetadata

getSnapshotManagement

@Stability(Stable)
@Nullable
default Object getSnapshotManagement()

Contains details about the Iceberg snapshot management settings for the table.

Returns union: either IResolvable or CfnTable.SnapshotManagementProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-snapshotmanagement

getStorageClassConfiguration

@Stability(Stable)
@Nullable
default Object getStorageClassConfiguration()

Specifies storage class settings for the table.

Returns union: either IResolvable or CfnTable.StorageClassConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-storageclassconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

User tags (key-value pairs) to associate with the table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tags

getWithoutMetadata

@Stability(Stable)
@Nullable
default String getWithoutMetadata()

Indicates that you don't want to specify a schema for the table.

This property is mutually exclusive to IcebergMetadata , and its only possible value is Yes .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-withoutmetadata

builder

@Stability(Stable)
static CfnTableProps.Builder builder()

Returns:

a CfnTableProps.Builder of CfnTableProps