Skip to content

CreateChannelRequest

Source code in docs_src/capo_kafka/types/create_channel_request.py
class CreateChannelRequest(TypedDict, closed=True):
    channel_name: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The name of the channel. Must be unique within the cluster.</p>"""
    cluster_arn: "capo_kafka.types.__string.__string"
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>"""
    encryption_configuration: NotRequired[
        "capo_kafka.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration applied to the channel.</p>"""
    iceberg_destination_configuration: NotRequired[
        "capo_kafka.types.iceberg_destination_configuration.IcebergDestinationConfiguration"
    ]
    """<p>The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.</p>"""
    s3_destination_configuration: NotRequired[
        "capo_kafka.types.s3_destination_configuration.S3DestinationConfiguration"
    ]
    """<p>The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.</p>"""
    tags: NotRequired["capo_kafka.types.__map_of__string.__mapOf__string"]
    """<p>The tags attached to the channel.</p>"""
    topic_configuration_list: NotRequired[
        "capo_kafka.types.__list_of_topic_configuration.__listOfTopicConfiguration"
    ]
    """<p>The list of topic configurations for the channel. Currently exactly one topic must be specified.</p>"""
    logging_info: NotRequired[
        "capo_kafka.types.channel_logging_info.ChannelLoggingInfo"
    ]
    """<p>The destinations to which the channel publishes operational logs.</p>"""

channel_name instance-attribute

channel_name: NotRequired[__string]

The name of the channel. Must be unique within the cluster.

cluster_arn instance-attribute

cluster_arn: __string

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration applied to the channel.

iceberg_destination_configuration instance-attribute

iceberg_destination_configuration: NotRequired[IcebergDestinationConfiguration]

The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.

logging_info instance-attribute

logging_info: NotRequired[ChannelLoggingInfo]

The destinations to which the channel publishes operational logs.

s3_destination_configuration instance-attribute

s3_destination_configuration: NotRequired[S3DestinationConfiguration]

The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.

tags instance-attribute

tags: NotRequired[__mapOf__string]

The tags attached to the channel.

topic_configuration_list instance-attribute

topic_configuration_list: NotRequired[__listOfTopicConfiguration]

The list of topic configurations for the channel. Currently exactly one topic must be specified.