Package software.amazon.awscdk.services.s3tables

Class CfnTableBucket

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3tables.CfnTableBucket
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITableBucketRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:28.906Z") @Stability(Stable) public class CfnTableBucket extends CfnResource implements IInspectable, ITableBucketRef, ITaggableV2
Creates a table bucket.

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

  • Permissions - - You must have the s3tables:CreateTableBucket permission to use this operation.
  • If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.
  • 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.services.s3tables.*;
 CfnTableBucket cfnTableBucket = CfnTableBucket.Builder.create(this, "MyCfnTableBucket")
         .tableBucketName("tableBucketName")
         // the properties below are optional
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseAlgorithm("sseAlgorithm")
                 .build())
         .metricsConfiguration(MetricsConfigurationProperty.builder()
                 .status("status")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .unreferencedFileRemoval(UnreferencedFileRemovalProperty.builder()
                 .noncurrentDays(123)
                 .status("status")
                 .unreferencedDays(123)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTableBucket

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

    • CfnTableBucket

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

    • CfnTableBucket

      @Stability(Stable) public CfnTableBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTableBucketProps props)
      Create a new AWS::S3Tables::TableBucket.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTableBucket

      @Stability(Stable) @NotNull public static String arnForTableBucket(@NotNull ITableBucketRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTableBucket

      @Stability(Stable) @NotNull public static Boolean isCfnTableBucket(@NotNull Object x)
      Checks whether the given object is a CfnTableBucket.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrTableBucketArn

      @Stability(Stable) @NotNull public String getAttrTableBucketArn()
      The Amazon Resource Name (ARN) of the table bucket.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTableBucketRef

      @Stability(Stable) @NotNull public TableBucketReference getTableBucketRef()
      A reference to a TableBucket resource.
      Specified by:
      getTableBucketRef in interface ITableBucketRef

    • getTableBucketName

      @Stability(Stable) @NotNull public String getTableBucketName()
      The name for the table bucket.

    • setTableBucketName

      @Stability(Stable) public void setTableBucketName(@NotNull String value)
      The name for the table bucket.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Configuration specifying how data should be encrypted.

      Returns union: either IResolvable or CfnTableBucket.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      Configuration specifying how data should be encrypted.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnTableBucket.EncryptionConfigurationProperty value)
      Configuration specifying how data should be encrypted.

    • getMetricsConfiguration

      @Stability(Stable) @Nullable public Object getMetricsConfiguration()
      Settings governing the Metric configuration for the table bucket.

      Returns union: either IResolvable or CfnTableBucket.MetricsConfigurationProperty

    • setMetricsConfiguration

      @Stability(Stable) public void setMetricsConfiguration(@Nullable IResolvable value)
      Settings governing the Metric configuration for the table bucket.

    • setMetricsConfiguration

      @Stability(Stable) public void setMetricsConfiguration(@Nullable CfnTableBucket.MetricsConfigurationProperty value)
      Settings governing the Metric configuration for the table bucket.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      User tags (key-value pairs) to associate with the table bucket.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      User tags (key-value pairs) to associate with the table bucket.

    • getUnreferencedFileRemoval

      @Stability(Stable) @Nullable public Object getUnreferencedFileRemoval()
      The unreferenced file removal settings for your table bucket.

      Returns union: either IResolvable or CfnTableBucket.UnreferencedFileRemovalProperty

    • setUnreferencedFileRemoval

      @Stability(Stable) public void setUnreferencedFileRemoval(@Nullable IResolvable value)
      The unreferenced file removal settings for your table bucket.

    • setUnreferencedFileRemoval

      @Stability(Stable) public void setUnreferencedFileRemoval(@Nullable CfnTableBucket.UnreferencedFileRemovalProperty value)
      The unreferenced file removal settings for your table bucket.