Skip to content

IcebergDestinationConfiguration

Source code in docs_src/capo_kafka/types/iceberg_destination_configuration.py
class IcebergDestinationConfiguration(TypedDict, closed=True):
    append_only: NotRequired["capo_kafka.types.__boolean.__boolean"]
    """<p>Whether the destination is append-only. Must be true; updates and deletes are not supported.</p>"""
    catalog: NotRequired["capo_kafka.types.catalog.Catalog"]
    """<p>The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.</p>"""
    data_freshness_in_seconds: NotRequired["capo_kafka.types.__integer.__integer"]
    """<p>The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.</p>"""
    dead_letter_queue_s3: NotRequired[
        "capo_kafka.types.dead_letter_queue_s3.DeadLetterQueueS3"
    ]
    """<p>The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.</p>"""
    destination_table_list: NotRequired[
        "capo_kafka.types.__list_of_destination_table.__listOfDestinationTable"
    ]
    """<p>The destination Iceberg tables. Currently exactly one table must be specified.</p>"""
    schema_evolution: NotRequired["capo_kafka.types.schema_evolution.SchemaEvolution"]
    """<p>Configuration controlling whether the destination table's schema is evolved to match incoming records.</p>"""
    service_execution_role_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.</p>"""
    table_creation: NotRequired["capo_kafka.types.table_creation.TableCreation"]
    """<p>Configuration controlling whether MSK creates the destination table if it does not already exist.</p>"""
    compression_type: NotRequired[
        "capo_kafka.types.iceberg_compression_type.IcebergCompressionType"
    ]
    """<p>The compression codec for Iceberg table data files. Defaults to ZSTD.</p>"""

append_only instance-attribute

append_only: NotRequired[__boolean]

Whether the destination is append-only. Must be true; updates and deletes are not supported.

catalog instance-attribute

catalog: NotRequired[Catalog]

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

compression_type instance-attribute

compression_type: NotRequired[IcebergCompressionType]

The compression codec for Iceberg table data files. Defaults to ZSTD.

data_freshness_in_seconds instance-attribute

data_freshness_in_seconds: NotRequired[__integer]

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

dead_letter_queue_s3 instance-attribute

dead_letter_queue_s3: NotRequired[DeadLetterQueueS3]

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

destination_table_list instance-attribute

destination_table_list: NotRequired[__listOfDestinationTable]

The destination Iceberg tables. Currently exactly one table must be specified.

schema_evolution instance-attribute

schema_evolution: NotRequired[SchemaEvolution]

Configuration controlling whether the destination table's schema is evolved to match incoming records.

service_execution_role_arn instance-attribute

service_execution_role_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

table_creation instance-attribute

table_creation: NotRequired[TableCreation]

Configuration controlling whether MSK creates the destination table if it does not already exist.