CfnTableBucketProps

class aws_cdk.aws_s3tables.CfnTableBucketProps(*, table_bucket_name, encryption_configuration=None, metrics_configuration=None, tags=None, unreferenced_file_removal=None)

Bases: object

Properties for defining a CfnTableBucket.

Parameters:

  • table_bucket_name (str) – The name for the table bucket.

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

  • metrics_configuration (Union[IResolvable, MetricsConfigurationProperty, Dict[str, Any], None]) – Settings governing the Metric configuration for the table bucket.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – User tags (key-value pairs) to associate with the table bucket.

  • unreferenced_file_removal (Union[IResolvable, UnreferencedFileRemovalProperty, Dict[str, Any], None]) – 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* .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3tables as s3tables

cfn_table_bucket_props = s3tables.CfnTableBucketProps(
    table_bucket_name="tableBucketName",

    # the properties below are optional
    encryption_configuration=s3tables.CfnTableBucket.EncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn",
        sse_algorithm="sseAlgorithm"
    ),
    metrics_configuration=s3tables.CfnTableBucket.MetricsConfigurationProperty(
        status="status"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    unreferenced_file_removal=s3tables.CfnTableBucket.UnreferencedFileRemovalProperty(
        noncurrent_days=123,
        status="status",
        unreferenced_days=123
    )
)

Attributes

encryption_configuration

Configuration specifying how data should be encrypted.

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

See:

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

metrics_configuration

Settings governing the Metric configuration for the table bucket.

See:

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

table_bucket_name

The name for the table bucket.

See:

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

tags

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

See:

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

unreferenced_file_removal

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* .

See:

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