CfnTableProps

class aws_cdk.aws_s3tables.CfnTableProps(*, namespace, open_table_format, table_bucket_arn, table_name, compaction=None, iceberg_metadata=None, snapshot_management=None, without_metadata=None)

Bases: object

Properties for defining a CfnTable.

Parameters:

namespace (str) – The name of the namespace.
open_table_format (str) – Format of the table.
table_bucket_arn (str) – The Amazon Resource Name (ARN) of the specified table bucket.
table_name (str) – The name for the table.
compaction (Union[IResolvable, CompactionProperty, Dict[str, Any], None]) – Settings governing the Compaction maintenance action. Contains details about the compaction settings for an Iceberg table.
iceberg_metadata (Union[IResolvable, IcebergMetadataProperty, Dict[str, Any], None]) – Contains details about the metadata for an Iceberg table.
snapshot_management (Union[IResolvable, SnapshotManagementProperty, Dict[str, Any], None]) – Contains details about the snapshot management settings for an Iceberg table. A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours.
without_metadata (Optional[str]) – Indicates that you don’t want to specify a schema for the table. This property is mutually exclusive to ‘IcebergMetadata’, and its only possible value is ‘Yes’.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.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_props = s3tables.CfnTableProps(
    namespace="namespace",
    open_table_format="openTableFormat",
    table_bucket_arn="tableBucketArn",
    table_name="tableName",

    # the properties below are optional
    compaction=s3tables.CfnTable.CompactionProperty(
        status="status",
        target_file_size_mb=123
    ),
    iceberg_metadata=s3tables.CfnTable.IcebergMetadataProperty(
        iceberg_schema=s3tables.CfnTable.IcebergSchemaProperty(
            schema_field_list=[s3tables.CfnTable.SchemaFieldProperty(
                name="name",
                type="type",

                # the properties below are optional
                required=False
            )]
        )
    ),
    snapshot_management=s3tables.CfnTable.SnapshotManagementProperty(
        max_snapshot_age_hours=123,
        min_snapshots_to_keep=123,
        status="status"
    ),
    without_metadata="withoutMetadata"
)