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

Class TableBucket

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.s3tables.alpha.TableBucket
All Implemented Interfaces:
IResource, ITableBucket, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:50.406Z") @Stability(Experimental) public class TableBucket extends Resource implements ITableBucket
(experimental) An S3 table bucket with helpers for associated resource policies.

This bucket may not yet have all features that exposed by the underlying CfnTableBucket.

Example: 

 TableBucket sampleTableBucket = TableBucket.Builder.create(scope, "ExampleTableBucket")
         .tableBucketName("example-bucket")
         // Optional fields:
         .unreferencedFileRemoval(UnreferencedFileRemoval.builder()
                 .noncurrentDays(123)
                 .status(UnreferencedFileRemovalStatus.ENABLED)
                 .unreferencedDays(123)
                 .build())
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

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

  • Constructor Details

    • TableBucket

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

    • TableBucket

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

    • TableBucket

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

  • Method Details

    • fromTableBucketArn

      @Stability(Experimental) @NotNull public static ITableBucket fromTableBucketArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String tableBucketArn)
      (experimental) Defines a TableBucket construct from an external table bucket ARN.

      Parameters:
      scope - The parent creating construct (usually this). This parameter is required.
      id - The construct's name. This parameter is required.
      tableBucketArn - Amazon Resource Name (arn) of the table bucket. This parameter is required.

    • fromTableBucketAttributes

      @Stability(Experimental) @NotNull public static ITableBucket fromTableBucketAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TableBucketAttributes attrs)
      (experimental) Defines a TableBucket construct that represents an external table bucket.

      Parameters:
      scope - The parent creating construct (usually this). This parameter is required.
      id - The construct's name. This parameter is required.
      attrs - A TableBucketAttributes object. This parameter is required.

    • validateTableBucketName

      @Stability(Experimental) public static void validateTableBucketName(@Nullable String bucketName)
      (experimental) Throws an exception if the given table bucket name is not valid.

      Parameters:
      bucketName - name of the bucket.

    • validateTableBucketName

      @Stability(Experimental) public static void validateTableBucketName()
      (experimental) Throws an exception if the given table bucket name is not valid.

    • validateUnreferencedFileRemoval

      @Stability(Experimental) public static void validateUnreferencedFileRemoval(@Nullable UnreferencedFileRemoval unreferencedFileRemoval)
      (experimental) Throws an exception if the given unreferencedFileRemovalProperty is not valid.

      Parameters:
      unreferencedFileRemoval - configuration for the table bucket.

    • validateUnreferencedFileRemoval

      @Stability(Experimental) public static void validateUnreferencedFileRemoval()
      (experimental) Throws an exception if the given unreferencedFileRemovalProperty is not valid.

    • addToResourcePolicy

      @Stability(Experimental) @NotNull public AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      (experimental) Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table bucket and/or its contents. Use tableBucketArn and arnForObjects(keys) to obtain ARNs for this bucket or objects.

      Note that the policy statement may or may not be added to the policy. For example, when an ITableBucket is created from an existing table bucket, it's not possible to tell whether the bucket already has a policy attached, let alone to re-use that policy to add more statements to it. So it's safest to do nothing in these cases.

      Specified by:
      addToResourcePolicy in interface ITableBucket
      Parameters:
      statement - the policy statement to be added to the bucket's policy. This parameter is required.
      Returns:
      metadata about the execution of this method. If the policy was not added, the value of statementAdded will be false. You should always check this value to make sure that the operation was actually carried out. Otherwise, synthesis and deploy will terminate silently, which may be confusing.

    • grantRead

      @Stability(Experimental) @NotNull public Grant grantRead(@NotNull IGrantable identity, @NotNull String tableId)
      (experimental) Grant read permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantRead in interface ITableBucket
      Parameters:
      identity - This parameter is required.
      tableId - This parameter is required.

    • grantReadWrite

      @Stability(Experimental) @NotNull public Grant grantReadWrite(@NotNull IGrantable identity, @NotNull String tableId)
      (experimental) Grant read and write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to encrypt/decrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantReadWrite in interface ITableBucket
      Parameters:
      identity - This parameter is required.
      tableId - This parameter is required.

    • grantWrite

      @Stability(Experimental) @NotNull public Grant grantWrite(@NotNull IGrantable identity, @NotNull String tableId)
      (experimental) Grant write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

      If encryption is used, permission to use the key to encrypt the contents of the bucket will also be granted to the same principal.

      Specified by:
      grantWrite in interface ITableBucket
      Parameters:
      identity - This parameter is required.
      tableId - This parameter is required.

    • getTableBucketArn

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

    • getTableBucketName

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

    • getEncryptionKey

      @Stability(Experimental) @Nullable public IKey getEncryptionKey()
      (experimental) Optional KMS encryption key associated with this table bucket.
      Specified by:
      getEncryptionKey in interface ITableBucket

    • getTableBucketPolicy

      @Stability(Experimental) @Nullable public TableBucketPolicy getTableBucketPolicy()
      (experimental) The resource policy for this tableBucket.

    • getAutoCreatePolicy

      @Stability(Experimental) @NotNull protected Boolean getAutoCreatePolicy()
      (experimental) Indicates if a table bucket resource policy should automatically created upon the first call to addToResourcePolicy.

    • setAutoCreatePolicy

      @Stability(Experimental) protected void setAutoCreatePolicy(@NotNull Boolean value)
      (experimental) Indicates if a table bucket resource policy should automatically created upon the first call to addToResourcePolicy.