Table

class aws_cdk.aws_s3tables_alpha.Table(scope, id, *, namespace, open_table_format, table_name, compaction=None, iceberg_metadata=None, removal_policy=None, snapshot_management=None, without_metadata=None)

Bases: Resource

(experimental) An S3 Table with helpers.

Stability:: experimental
ExampleMetadata:: infused

Example:

# Build a table
sample_table = Table(scope, "ExampleTable",
    table_name="example_table",
    namespace=namespace,
    open_table_format=OpenTableFormat.ICEBERG,
    without_metadata=True
)

# Build a table with an Iceberg Schema
sample_table_with_schema = Table(scope, "ExampleSchemaTable",
    table_name="example_table_with_schema",
    namespace=namespace,
    open_table_format=OpenTableFormat.ICEBERG,
    iceberg_metadata=IcebergMetadataProperty(
        iceberg_schema=IcebergSchemaProperty(
            schema_field_list=[SchemaFieldProperty(
                name="id",
                type="int",
                required=True
            ), SchemaFieldProperty(
                name="name",
                type="string"
            )
            ]
        )
    ),
    compaction=CompactionProperty(
        status=Status.ENABLED,
        target_file_size_mb=128
    ),
    snapshot_management=SnapshotManagementProperty(
        status=Status.ENABLED,
        max_snapshot_age_hours=48,
        min_snapshots_to_keep=5
    )
)

Parameters:

scope (Construct)
id (str)
namespace (INamespace) – (experimental) The namespace under which this table is created.
open_table_format (OpenTableFormat) – (experimental) Format of this table. Currently, the only supported value is OpenTableFormat.ICEBERG.
table_name (str) – (experimental) Name of this table, unique within the namespace.
compaction (Union[CompactionProperty, Dict[str, Any], None]) – (experimental) Settings governing the Compaction maintenance action. Default: Amazon S3 selects the best compaction strategy based on your table sort order.
iceberg_metadata (Union[IcebergMetadataProperty, Dict[str, Any], None]) – (experimental) Contains details about the metadata for an Iceberg table. Default: table is created without any metadata
removal_policy (Optional[RemovalPolicy]) – (experimental) Controls what happens to this table it it stoped being managed by cloudformation. Default: RETAIN
snapshot_management (Union[SnapshotManagementProperty, Dict[str, Any], None]) – (experimental) Contains details about the snapshot management settings for an Iceberg table. Default: enabled: MinimumSnapshots is 1 by default and MaximumSnapshotAge is 120 hours by default.
without_metadata (Optional[bool]) – (experimental) If true, indicates that you don’t want to specify a schema for the table. This property is mutually exclusive to ‘IcebergMetadata’. Default: false

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-s3tables-alpha.Table'

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

namespace

(experimental) The namespace containing this table.

Stability:: experimental

node: The tree node.

stack: The stack in which this resource is defined.

table_arn

(experimental) The unique Amazon Resource Name (arn) of this table.

Stability:: experimental

table_name

(experimental) The name of this table.

Stability:: experimental

Static Methods

classmethod from_table_attributes(scope, id, *, table_arn, table_name)

(experimental) Defines a Table construct that represents an external table.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
table_arn (str) – (experimental) The table’s ARN.
table_name (str) – (experimental) Name of this table.

Stability:

experimental

Return type:

ITable

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

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

classmethod is_resource(construct)

Check whether the given construct is a Resource.

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

classmethod validate_table_name(table_name)

(experimental) See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.

Parameters:: table_name (str) – Name of the table.
Stability:: experimental
Throws:: UnscopedValidationError if any naming errors are detected
Return type:: None