CfnTableBucketPropsMixin

class aws_cdk.mixins_preview.aws_s3tables.mixins.CfnTableBucketPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a table bucket.

For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide .

Permissions - - You must have the s3tables:CreateTableBucket permission to use this operation.
If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.
Cloud Development Kit - To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:
NPM: `npm i

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

/aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource:: AWS::S3Tables::TableBucket
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_table_bucket_props_mixin = s3tables_mixins.CfnTableBucketPropsMixin(s3tables_mixins.CfnTableBucketMixinProps(
    encryption_configuration=s3tables_mixins.CfnTableBucketPropsMixin.EncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn",
        sse_algorithm="sseAlgorithm"
    ),
    metrics_configuration=s3tables_mixins.CfnTableBucketPropsMixin.MetricsConfigurationProperty(
        status="status"
    ),
    storage_class_configuration=s3tables_mixins.CfnTableBucketPropsMixin.StorageClassConfigurationProperty(
        storage_class="storageClass"
    ),
    table_bucket_name="tableBucketName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    unreferenced_file_removal=s3tables_mixins.CfnTableBucketPropsMixin.UnreferencedFileRemovalProperty(
        noncurrent_days=123,
        status="status",
        unreferenced_days=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::S3Tables::TableBucket.

Parameters:

props (Union[CfnTableBucketMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['encryptionConfiguration', 'metricsConfiguration', 'storageClassConfiguration', 'tableBucketName', 'tags', 'unreferencedFileRemoval']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EncryptionConfigurationProperty

class CfnTableBucketPropsMixin.EncryptionConfigurationProperty(*, kms_key_arn=None, sse_algorithm=None)

Bases: object

Configuration specifying how data should be encrypted.

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

Parameters:

kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms .
sse_algorithm (Optional[str]) – The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.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.mixins_preview.aws_s3tables import mixins as s3tables_mixins

encryption_configuration_property = s3tables_mixins.CfnTableBucketPropsMixin.EncryptionConfigurationProperty(
    kms_key_arn="kmsKeyArn",
    sse_algorithm="sseAlgorithm"
)

Attributes

kms_key_arn

The Amazon Resource Name (ARN) of the KMS key to use for encryption.

This field is required only when sseAlgorithm is set to aws:kms .

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

sse_algorithm

The server-side encryption algorithm to use.

Valid values are AES256 for S3-managed encryption keys, or aws:kms for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption .

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

MetricsConfigurationProperty

class CfnTableBucketPropsMixin.MetricsConfigurationProperty(*, status=None)

Bases: object

Settings governing the Metric configuration for the table bucket.

Parameters:: status (Optional[str]) – Indicates whether Metrics are enabled. Default: - “Disabled”
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-metricsconfiguration.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.mixins_preview.aws_s3tables import mixins as s3tables_mixins

metrics_configuration_property = s3tables_mixins.CfnTableBucketPropsMixin.MetricsConfigurationProperty(
    status="status"
)

Attributes

status

Indicates whether Metrics are enabled.

Default:

“Disabled”

See:

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

StorageClassConfigurationProperty

class CfnTableBucketPropsMixin.StorageClassConfigurationProperty(*, storage_class=None)

Bases: object

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.

Parameters:: storage_class (Optional[str]) – The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-storageclassconfiguration.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.mixins_preview.aws_s3tables import mixins as s3tables_mixins

storage_class_configuration_property = s3tables_mixins.CfnTableBucketPropsMixin.StorageClassConfigurationProperty(
    storage_class="storageClass"
)

Attributes

storage_class

The storage class for the table or table bucket.

Valid values include storage classes optimized for different access patterns and cost profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-storageclassconfiguration.html#cfn-s3tables-tablebucket-storageclassconfiguration-storageclass

UnreferencedFileRemovalProperty

class CfnTableBucketPropsMixin.UnreferencedFileRemovalProperty(*, noncurrent_days=None, status=None, unreferenced_days=None)

Bases: object

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

Parameters:

noncurrent_days (Union[int, float, None]) – The number of days an object can be noncurrent before Amazon S3 deletes it.
status (Optional[str]) – The status of the unreferenced file removal configuration for your table bucket.
unreferenced_days (Union[int, float, None]) – The number of days an object must be unreferenced by your table before Amazon S3 marks the object as noncurrent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.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.mixins_preview.aws_s3tables import mixins as s3tables_mixins

unreferenced_file_removal_property = s3tables_mixins.CfnTableBucketPropsMixin.UnreferencedFileRemovalProperty(
    noncurrent_days=123,
    status="status",
    unreferenced_days=123
)

Attributes

noncurrent_days

The number of days an object can be noncurrent before Amazon S3 deletes it.

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

status

The status of the unreferenced file removal configuration for your table bucket.

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

unreferenced_days

The number of days an object must be unreferenced by your table before Amazon S3 marks the object as noncurrent.

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