Skip to content

KafkaAction

Source code in docs_src/capo_iot/types/kafka_action.py
class KafkaAction(TypedDict, closed=True):
    destination_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of Kafka action's VPC <code>TopicRuleDestination</code>.</p>"""
    topic: "capo_iot.types.string.String"
    """<p>The Kafka topic for messages to be sent to the Kafka broker.</p>"""
    key: NotRequired["capo_iot.types.string.String"]
    """<p>The Kafka message key.</p>"""
    partition: NotRequired["capo_iot.types.string.String"]
    """<p>The Kafka message partition.</p>"""
    client_properties: "capo_iot.types.client_properties.ClientProperties"
    """<p>Properties of the Apache Kafka producer client.</p>"""
    headers: NotRequired["capo_iot.types.kafka_headers.KafkaHeaders"]
    """<p>The list of Kafka headers that you specify.</p>"""

client_properties instance-attribute

client_properties: ClientProperties

Properties of the Apache Kafka producer client.

destination_arn instance-attribute

destination_arn: AwsArn

The ARN of Kafka action's VPC TopicRuleDestination.

headers instance-attribute

headers: NotRequired[KafkaHeaders]

The list of Kafka headers that you specify.

key instance-attribute

key: NotRequired[String]

The Kafka message key.

partition instance-attribute

partition: NotRequired[String]

The Kafka message partition.

topic instance-attribute

topic: String

The Kafka topic for messages to be sent to the Kafka broker.