Skip to content

MSKSourceDescription

Source code in docs_src/capo_firehose/types/msk_source_description.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class MSKSourceDescription(TypedDict, closed=True):
    msk_cluster_arn: NotRequired["capo_firehose.types.msk_cluster_arn.MSKClusterARN"]
    """<p>The ARN of the Amazon MSK cluster.</p>"""
    topic_name: NotRequired["capo_firehose.types.topic_name.TopicName"]
    """<p>The topic name within the Amazon MSK cluster.</p>"""
    authentication_configuration: NotRequired[
        "capo_firehose.types.authentication_configuration.AuthenticationConfiguration"
    ]
    """<p>The authentication configuration of the Amazon MSK cluster.</p>"""
    delivery_start_timestamp: NotRequired[
        "capo_firehose.types.delivery_start_timestamp.DeliveryStartTimestamp"
    ]
    """<p>Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.</p>"""
    read_from_timestamp: NotRequired[
        "capo_firehose.types.read_from_timestamp.ReadFromTimestamp"
    ]
    """<p>The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active. </p> <p>If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the <code>ReadFromTimestampUTC</code> parameter to Epoch (1970-01-01T00:00:00Z). </p>"""

authentication_configuration instance-attribute 

authentication_configuration: NotRequired[AuthenticationConfiguration]

The authentication configuration of the Amazon MSK cluster.

delivery_start_timestamp instance-attribute 

delivery_start_timestamp: NotRequired[DeliveryStartTimestamp]

Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

msk_cluster_arn instance-attribute 

msk_cluster_arn: NotRequired[MSKClusterARN]

The ARN of the Amazon MSK cluster.

read_from_timestamp instance-attribute 

read_from_timestamp: NotRequired[ReadFromTimestamp]

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

topic_name instance-attribute 

topic_name: NotRequired[TopicName]

The topic name within the Amazon MSK cluster.