Skip to content

IcebergDestinationDescription

Source code in docs_src/capo_firehose/types/iceberg_destination_description.py
class IcebergDestinationDescription(TypedDict, closed=True):
    destination_table_configuration_list: NotRequired[
        "capo_firehose.types.destination_table_configuration_list.DestinationTableConfigurationList"
    ]
    """<p> Provides a list of <code>DestinationTableConfigurations</code> which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.</p>"""
    schema_evolution_configuration: NotRequired[
        "capo_firehose.types.schema_evolution_configuration.SchemaEvolutionConfiguration"
    ]
    """<p>The description of automatic schema evolution configuration.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    table_creation_configuration: NotRequired[
        "capo_firehose.types.table_creation_configuration.TableCreationConfiguration"
    ]
    """<p> The description of table creation configuration. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    buffering_hints: NotRequired["capo_firehose.types.buffering_hints.BufferingHints"]
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    s3_backup_mode: NotRequired[
        "capo_firehose.types.iceberg_s3_backup_mode.IcebergS3BackupMode"
    ]
    """<p> Describes how Firehose will backup records. Currently,Firehose only supports <code>FailedDataOnly</code>. </p>"""
    retry_options: NotRequired["capo_firehose.types.retry_options.RetryOptions"]
    role_arn: NotRequired["capo_firehose.types.role_arn.RoleARN"]
    """<p> The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables. </p>"""
    append_only: NotRequired["capo_firehose.types.boolean_object.BooleanObject"]
    """<p> Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.</p> <p>The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.</p> <p> </p>"""
    catalog_configuration: NotRequired[
        "capo_firehose.types.catalog_configuration.CatalogConfiguration"
    ]
    """<p> Configuration describing where the destination Iceberg tables are persisted. </p>"""
    s3_destination_description: NotRequired[
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    ]

append_only instance-attribute

append_only: NotRequired[BooleanObject]

Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.

The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.

buffering_hints instance-attribute

buffering_hints: NotRequired[BufferingHints]

catalog_configuration instance-attribute

catalog_configuration: NotRequired[CatalogConfiguration]

Configuration describing where the destination Iceberg tables are persisted.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

destination_table_configuration_list instance-attribute

destination_table_configuration_list: NotRequired[DestinationTableConfigurationList]

Provides a list of DestinationTableConfigurations which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

retry_options instance-attribute

retry_options: NotRequired[RetryOptions]

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[IcebergS3BackupMode]

Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly.

s3_destination_description instance-attribute

s3_destination_description: NotRequired[S3DestinationDescription]

schema_evolution_configuration instance-attribute

schema_evolution_configuration: NotRequired[SchemaEvolutionConfiguration]

The description of automatic schema evolution configuration.

Amazon Data Firehose is in preview release and is subject to change.

table_creation_configuration instance-attribute

table_creation_configuration: NotRequired[TableCreationConfiguration]

The description of table creation configuration.

Amazon Data Firehose is in preview release and is subject to change.