TableBucketProps

class aws_cdk.aws_s3tables_alpha.TableBucketProps(*, table_bucket_name, account=None, encryption=None, encryption_key=None, region=None, removal_policy=None, unreferenced_file_removal=None)

Bases: object

(experimental) Parameters for constructing a TableBucket.

Parameters:

  • table_bucket_name (str) – (experimental) Name of the S3 TableBucket.

  • account (Optional[str]) – (experimental) 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 (Optional[TableBucketEncryption]) – (experimental) The kind of server-side encryption to apply to this bucket. If you choose KMS, you can specify a KMS key via encryptionKey. If encryption key is not specified, a key will automatically be created. Default: - KMS if encryptionKey is specified, or S3_MANAGED otherwise.

  • encryption_key (Optional[IKey]) – (experimental) External KMS key to use for bucket encryption. The encryption property must be either not specified or set to KMS. An error will be emitted if encryption is set to S3_MANAGED. Default: - If encryption is set to KMS and this property is undefined, a new KMS key will be created and associated with this bucket.

  • region (Optional[str]) – (experimental) 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

  • removal_policy (Optional[RemovalPolicy]) – (experimental) Controls what happens to this table bucket it it stoped being managed by cloudformation. Default: RETAIN

  • unreferenced_file_removal (Union[UnreferencedFileRemoval, Dict[str, Any], None]) – (experimental) Unreferenced file removal settings for the S3 TableBucket. Default: Enabled with default values

Stability:

experimental

ExampleMetadata:

infused

Example:

# Build a Table bucket
sample_table_bucket = TableBucket(scope, "ExampleTableBucket",
    table_bucket_name="example-bucket-1",
    # optional fields:
    unreferenced_file_removal=UnreferencedFileRemoval(
        status=UnreferencedFileRemovalStatus.ENABLED,
        noncurrent_days=20,
        unreferenced_days=20
    )
)

Attributes

account

(experimental) 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

Stability:

experimental

encryption

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

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

Default:

  • KMS if encryptionKey is specified, or S3_MANAGED otherwise.

Stability:

experimental

encryption_key

(experimental) External KMS key to use for bucket encryption.

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

Default:

  • If encryption is set to KMS and this property is undefined,

a new KMS key will be created and associated with this bucket.

Stability:

experimental

region

(experimental) 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

Stability:

experimental

removal_policy

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

Default:

RETAIN

Stability:

experimental

table_bucket_name

(experimental) Name of the S3 TableBucket.

Stability:

experimental

Link:

https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html#table-buckets-naming-rules

unreferenced_file_removal

(experimental) Unreferenced file removal settings for the S3 TableBucket.

Default:

Enabled with default values

See:

https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html

Stability:

experimental

Link:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html