Skip to content
v2.274.0

Experimental

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

TableBucketAttributes Struct ​

A reference to a table bucket outside this stack.

The tableBucketName, region, and account can be provided explicitly or will be inferred from the tableBucketArn

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const key: kms.Key;
const tableBucketAttributes: s3tables_alpha.TableBucketAttributes = {
  account: 'account',
  encryptionKey: key,
  region: 'region',
  tableBucketArn: 'tableBucketArn',
  tableBucketName: 'tableBucketName',
};

Properties ​

accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#
The accountId containing this table bucket.

Default: account inferred from scope

encryptionKeyoptionalIKeyencryption_keyoptionalIKeyencryptionKeyoptionalIKeyEncryptionKeyoptionalIKeyEncryptionKeyoptionalIKey= undefined#
Optional KMS encryption key associated with this bucket.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
AWS region this table bucket exists in.

Default: region inferred from scope

tableBucketArnoptionalstringtable_bucket_arnoptionalstrtableBucketArnoptionalStringTableBucketArnoptionalstringTableBucketArnoptional*string#
The table bucket's ARN.

Default: tableBucketArn constructed from region, account and tableBucketName are provided

tableBucketNameoptionalstringtable_bucket_nameoptionalstrtableBucketNameoptionalStringTableBucketNameoptionalstringTableBucketNameoptional*string#
The table bucket name, unique per region.

Default: tableBucketName inferred from arn