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

Class Table

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.s3tables.alpha.Table
All Implemented Interfaces:
IResource, ITable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-08-06T18:14:48.677Z") @Stability(Experimental) public class Table extends Resource implements ITable
(experimental) An S3 Table with helpers.

Example: 

 // Build a table
 Table sampleTable = Table.Builder.create(scope, "ExampleTable")
         .tableName("example_table")
         .namespace(namespace)
         .openTableFormat(OpenTableFormat.ICEBERG)
         .withoutMetadata(true)
         .build();
 // Build a table with an Iceberg Schema
 Table sampleTableWithSchema = Table.Builder.create(scope, "ExampleSchemaTable")
         .tableName("example_table_with_schema")
         .namespace(namespace)
         .openTableFormat(OpenTableFormat.ICEBERG)
         .icebergMetadata(IcebergMetadataProperty.builder()
                 .icebergSchema(IcebergSchemaProperty.builder()
                         .schemaFieldList(List.of(SchemaFieldProperty.builder()
                                 .name("id")
                                 .type("int")
                                 .required(true)
                                 .build(), SchemaFieldProperty.builder()
                                 .name("name")
                                 .type("string")
                                 .build()))
                         .build())
                 .build())
         .compaction(CompactionProperty.builder()
                 .status(Status.ENABLED)
                 .targetFileSizeMb(128)
                 .build())
         .snapshotManagement(SnapshotManagementProperty.builder()
                 .status(Status.ENABLED)
                 .maxSnapshotAgeHours(48)
                 .minSnapshotsToKeep(5)
                 .build())
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Table.Builder
    (experimental) A fluent builder for Table.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3tables.alpha.ITable

    ITable.Jsii$Default, ITable.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROPERTY_INJECTION_ID
    (experimental) Uniquely identifies this class.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Table(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Table(software.constructs.Construct scope, String id, TableProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ITable
    fromTableAttributes(software.constructs.Construct scope, String id, TableAttributes attrs)
    (experimental) Defines a Table construct that represents an external table.
    INamespace
    getNamespace()
    (experimental) The namespace containing this table.
    String
    getTableArn()
    (experimental) The unique Amazon Resource Name (arn) of this table.
    String
    getTableName()
    (experimental) The name of this table.
    static void
    validateTableName(String tableName)
    (experimental) See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.awscdk.services.s3tables.alpha.ITable

    getAccount, getRegion

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • Table

      protected Table(software.amazon.jsii.JsiiObjectRef objRef)

    • Table

      protected Table(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Table

      @Stability(Experimental) public Table(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TableProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromTableAttributes

      @Stability(Experimental) @NotNull public static ITable fromTableAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TableAttributes attrs)
      (experimental) Defines a Table construct that represents an external table.

      Parameters:
      scope - The parent creating construct (usually this). This parameter is required.
      id - The construct's name. This parameter is required.
      attrs - A TableAttributes object containing the table name and ARN. This parameter is required.

    • validateTableName

      @Stability(Experimental) public static void validateTableName(@NotNull String tableName)
      (experimental) See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.

      Parameters:
      tableName - Name of the table. This parameter is required.

    • getNamespace

      @Stability(Experimental) @NotNull public INamespace getNamespace()
      (experimental) The namespace containing this table.

    • getTableArn

      @Stability(Experimental) @NotNull public String getTableArn()
      (experimental) The unique Amazon Resource Name (arn) of this table.
      Specified by:
      getTableArn in interface ITable

    • getTableName

      @Stability(Experimental) @NotNull public String getTableName()
      (experimental) The name of this table.
      Specified by:
      getTableName in interface ITable