@aws-cdk/aws-s3tables-alpha.TableBucketProps

Experimental

@aws-cdk/aws-s3tables-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TableBucketProps Struct

Parameters for constructing a TableBucket.

TableBucketProps

used as props by

• TableBucket

Stability

Experimental

Source

lib/table-bucket.ts

Type last changed

v2.271.0-alpha.0 · 26 Sep 2026

Example

// Build a Table bucket
const sampleTableBucket = new TableBucket(scope, 'ExampleTableBucket', {
    // optional fields:
    tableBucketName: 'example-bucket-1', // if omitted, CDK generates a unique name that satisfies the S3 Tables naming rules
    unreferencedFileRemoval: {
        status: UnreferencedFileRemovalStatus.ENABLED,
        noncurrentDays: 20,
        unreferencedDays: 20,
    }
});

from aws_cdk.aws_s3tables_alpha import UnreferencedFileRemoval
# Build a Table bucket
sample_table_bucket = TableBucket(scope, "ExampleTableBucket",
    # optional fields:
    table_bucket_name="example-bucket-1",  # if omitted, CDK generates a unique name that satisfies the S3 Tables naming rules
    unreferenced_file_removal=UnreferencedFileRemoval(
        status=UnreferencedFileRemovalStatus.ENABLED,
        noncurrent_days=20,
        unreferenced_days=20
    )
)

// Build a Table bucket
TableBucket sampleTableBucket = TableBucket.Builder.create(scope, "ExampleTableBucket")
        // optional fields:
        .tableBucketName("example-bucket-1") // if omitted, CDK generates a unique name that satisfies the S3 Tables naming rules
        .unreferencedFileRemoval(UnreferencedFileRemoval.builder()
                .status(UnreferencedFileRemovalStatus.ENABLED)
                .noncurrentDays(20)
                .unreferencedDays(20)
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.AWS.S3Tables.Alpha
// Build a Table bucket
var sampleTableBucket = new TableBucket(scope, "ExampleTableBucket", new TableBucketProps {
    // optional fields:
    TableBucketName = "example-bucket-1",  // if omitted, CDK generates a unique name that satisfies the S3 Tables naming rules
    UnreferencedFileRemoval = new UnreferencedFileRemoval {
        Status = UnreferencedFileRemovalStatus.ENABLED,
        NoncurrentDays = 20,
        UnreferencedDays = 20
    }
});

// Build a Table bucket
sampleTableBucket := awscdkawss3tablesalpha.NewTableBucket(*scope, jsii.String("ExampleTableBucket"), &TableBucketProps{
	// optional fields:
	TableBucketName: jsii.String("example-bucket-1"),
	 // if omitted, CDK generates a unique name that satisfies the S3 Tables naming rules
	UnreferencedFileRemoval: &UnreferencedFileRemoval{
		Status: *awscdkawss3tablesalpha.UnreferencedFileRemovalStatus_ENABLED,
		NoncurrentDays: jsii.Number(20),
		UnreferencedDays: jsii.Number(20),
	},
})

Properties

account?optionalstringaccount?optionalstraccount?optionalStringAccount?optionalstringAccount?optional*string#

AWS Account ID of the table bucket owner.

Default: it's assumed the bucket belongs to the same account as the scope it's being imported into

encryption?optionalTableBucketEncryptionencryption?optionalTableBucketEncryptionencryption?optionalTableBucketEncryptionEncryption?optionalTableBucketEncryptionEncryption?optionalTableBucketEncryption#

The kind of server-side encryption to apply to this bucket.

Default: KMS if encryptionKey is specified, or S3_MANAGED otherwise.

If you choose KMS, you can specify a KMS key via encryptionKey. If encryption key is not specified, a key will automatically be created.

encryptionKey?optionalIKeyencryption_key?optionalIKeyencryptionKey?optionalIKeyEncryptionKey?optionalIKeyEncryptionKey?optionalIKey#

External KMS key to use for bucket encryption.

Default: If encryption is set to KMS and this property is undefined, a new KMS key will be created and associated with this bucket.

The encryption property must be either not specified or set to KMS. An error will be emitted if encryption is set to S3_MANAGED.

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

AWS region that the table bucket exists in.

Default: it's assumed the bucket is in the same region as the scope it's being imported into

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy= RETAIN#

Controls what happens to this table bucket it it stoped being managed by cloudformation.

requestMetricsStatus?optionalRequestMetricsStatusrequest_metrics_status?optionalRequestMetricsStatusrequestMetricsStatus?optionalRequestMetricsStatusRequestMetricsStatus?optionalRequestMetricsStatusRequestMetricsStatus?optionalRequestMetricsStatus#

CloudWatch request metrics configuration for the table bucket.

Default: Request metrics are disabled

When enabled, S3 Tables publishes CloudWatch request metrics for the table bucket. Request metrics provide insight into Amazon S3 Tables requests.

storageClass?optionalStorageClassstorage_class?optionalStorageClassstorageClass?optionalStorageClassStorageClass?optionalStorageClassStorageClass?optionalStorageClass#

The storage class for the table bucket.

Default: STANDARD storage class

Determines the storage tier used for table data, allowing optimization for different access patterns and cost profiles.

tableBucketName?optionalstringtable_bucket_name?optionalstrtableBucketName?optionalStringTableBucketName?optionalstringTableBucketName?optional*string#

Name of the S3 TableBucket.

Default: generated by CDK from the stack and construct path.

unreferencedFileRemoval?optionalUnreferencedFileRemovalunreferenced_file_removal?optionalUnreferencedFileRemovalunreferencedFileRemoval?optionalUnreferencedFileRemovalUnreferencedFileRemoval?optionalUnreferencedFileRemovalUnreferencedFileRemoval?optionalUnreferencedFileRemoval#

Unreferenced file removal settings for the S3 TableBucket.

Default: Enabled with default values