Skip to content

MSKSourceConfiguration

Used by
Source code in docs_src/capo_firehose/types/msk_source_configuration.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class MSKSourceConfiguration(TypedDict, closed=True):
    msk_cluster_arn: "capo_firehose.types.msk_cluster_arn.MSKClusterARN"
    """<p>The ARN of the Amazon MSK cluster.</p>"""
    topic_name: "capo_firehose.types.topic_name.TopicName"
    """<p>The topic name within the Amazon MSK cluster. </p>"""
    authentication_configuration: (
        "capo_firehose.types.authentication_configuration.AuthenticationConfiguration"
    )
    """<p>The authentication configuration of the Amazon MSK cluster.</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>ReadFromTimestamp</code> parameter to Epoch (1970-01-01T00:00:00Z). </p>"""

authentication_configuration instance-attribute 

authentication_configuration: AuthenticationConfiguration

The authentication configuration of the Amazon MSK cluster.

msk_cluster_arn instance-attribute 

msk_cluster_arn: 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 ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

topic_name instance-attribute 

topic_name: TopicName

The topic name within the Amazon MSK cluster.