Package software.amazon.awscdk.cfnpropertymixins.services.s3tables

Class CfnTablePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3tables.CfnTablePropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.843Z") @Stability(Stable) public class CfnTablePropsMixin extends Mixin implements software.constructs.IMixin
Creates a new table associated with the given namespace in a table bucket.

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

  • Permissions - - You must have the s3tables:CreateTable permission to use this operation.
  • If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.
  • If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PutTableEncryption permission.

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption .

  • Cloud Development Kit - To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:
  • NPM: `npm i

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3tables.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTablePropsMixin cfnTablePropsMixin = CfnTablePropsMixin.Builder.create(CfnTableMixinProps.builder()
         .compaction(CompactionProperty.builder()
                 .status("status")
                 .targetFileSizeMb(123)
                 .build())
         .icebergMetadata(IcebergMetadataProperty.builder()
                 .icebergPartitionSpec(IcebergPartitionSpecProperty.builder()
                         .fields(List.of(IcebergPartitionFieldProperty.builder()
                                 .fieldId(123)
                                 .name("name")
                                 .sourceId(123)
                                 .transform("transform")
                                 .build()))
                         .specId(123)
                         .build())
                 .icebergSchema(IcebergSchemaProperty.builder()
                         .schemaFieldList(List.of(SchemaFieldProperty.builder()
                                 .id(123)
                                 .name("name")
                                 .required(false)
                                 .type("type")
                                 .build()))
                         .build())
                 .icebergSortOrder(IcebergSortOrderProperty.builder()
                         .fields(List.of(IcebergSortFieldProperty.builder()
                                 .direction("direction")
                                 .nullOrder("nullOrder")
                                 .sourceId(123)
                                 .transform("transform")
                                 .build()))
                         .orderId(123)
                         .build())
                 .tableProperties(Map.of(
                         "tablePropertiesKey", "tableProperties"))
                 .build())
         .namespace("namespace")
         .openTableFormat("openTableFormat")
         .snapshotManagement(SnapshotManagementProperty.builder()
                 .maxSnapshotAgeHours(123)
                 .minSnapshotsToKeep(123)
                 .status("status")
                 .build())
         .storageClassConfiguration(StorageClassConfigurationProperty.builder()
                 .storageClass("storageClass")
                 .build())
         .tableBucketArn("tableBucketArn")
         .tableName("tableName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .withoutMetadata("withoutMetadata")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnTablePropsMixin

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

    • CfnTablePropsMixin

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

    • CfnTablePropsMixin

      @Stability(Stable) public CfnTablePropsMixin(@NotNull CfnTableMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3Tables::Table.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnTablePropsMixin

      @Stability(Stable) public CfnTablePropsMixin(@NotNull CfnTableMixinProps props)
      Create a mixin to apply properties to AWS::S3Tables::Table.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnTableMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()