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.112.0 (build de1bc80)",
           date="2025-07-16T11:43:22.249Z")
@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())
         .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()	Settings governing the Compaction maintenance action.
default Object	getIcebergMetadata()	Contains details about the metadata for an Iceberg table.
String	getNamespace()	The name of the namespace.
String	getOpenTableFormat()	Format of the table.
default Object	getSnapshotManagement()	Contains details about the snapshot management settings for an Iceberg table.
String	getTableBucketArn()	The Amazon Resource Name (ARN) of the specified table bucket.
String	getTableName()	The name for 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()

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 specified table bucket.

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

Settings governing the Compaction maintenance action.

Contains details about the compaction settings for an Iceberg table.

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.

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 snapshot management settings for an Iceberg table.

A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours.

See Also:

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

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