Package software.amazon.awscdk.services.s3tables

Interface CfnTableBucketProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTableBucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:04:01.655Z")
@Stability(Stable)
public interface CfnTableBucketProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTableBucket.

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.*;
 CfnTableBucketProps cfnTableBucketProps = CfnTableBucketProps.builder()
         .tableBucketName("tableBucketName")
         // the properties below are optional
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseAlgorithm("sseAlgorithm")
                 .build())
         .metricsConfiguration(MetricsConfigurationProperty.builder()
                 .status("status")
                 .build())
         .storageClassConfiguration(StorageClassConfigurationProperty.builder()
                 .storageClass("storageClass")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .unreferencedFileRemoval(UnreferencedFileRemovalProperty.builder()
                 .noncurrentDays(123)
                 .status("status")
                 .unreferencedDays(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTableBucketProps.Builder	A builder for CfnTableBucketProps
static final class	CfnTableBucketProps.Jsii$Proxy	An implementation for CfnTableBucketProps

Method Summary

Modifier and Type	Method	Description
static CfnTableBucketProps.Builder	builder()
default Object	getEncryptionConfiguration()	Configuration specifying how data should be encrypted.
default Object	getMetricsConfiguration()	Settings governing the Metric configuration for the table bucket.
default Object	getStorageClassConfiguration()	The configuration details for the storage class of tables or table buckets.
String	getTableBucketName()	The name for the table bucket.
default List<CfnTag>	getTags()	User tags (key-value pairs) to associate with the table bucket.
default Object	getUnreferencedFileRemoval()	The unreferenced file removal settings for your table bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTableBucketName

@Stability(Stable)
@NotNull
String getTableBucketName()

The name for the table bucket.

See Also:

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

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

Configuration specifying how data should be encrypted.

This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

Returns union: either IResolvable or CfnTableBucket.EncryptionConfigurationProperty

See Also:

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

getMetricsConfiguration

@Stability(Stable)
@Nullable
default Object getMetricsConfiguration()

Settings governing the Metric configuration for the table bucket.

Returns union: either IResolvable or CfnTableBucket.MetricsConfigurationProperty

See Also:

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

getStorageClassConfiguration

@Stability(Stable)
@Nullable
default Object getStorageClassConfiguration()

The configuration details for the storage class of tables or table buckets.

This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.

Returns union: either IResolvable or CfnTableBucket.StorageClassConfigurationProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

User tags (key-value pairs) to associate with the table bucket.

See Also:

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

getUnreferencedFileRemoval

@Stability(Stable)
@Nullable
default Object getUnreferencedFileRemoval()

The unreferenced file removal settings for your table bucket.

Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the Amazon S3 User Guide .

Returns union: either IResolvable or CfnTableBucket.UnreferencedFileRemovalProperty

See Also:

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

builder

@Stability(Stable)
static CfnTableBucketProps.Builder builder()

Returns:

a CfnTableBucketProps.Builder of CfnTableBucketProps