Skip to content

UpdatePipeSourceParameters

Source code in docs_src/capo_pipes/types/update_pipe_source_parameters.py
class UpdatePipeSourceParameters(TypedDict, closed=True):
    filter_criteria: NotRequired["capo_pipes.types.filter_criteria.FilterCriteria"]
    """<p>The collection of event patterns used to filter events.</p> <p>To remove a filter, specify a <code>FilterCriteria</code> object with an empty array of <code>Filter</code> objects.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    kinesis_stream_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_kinesis_stream_parameters.UpdatePipeSourceKinesisStreamParameters"
    ]
    """<p>The parameters for using a Kinesis stream as a source.</p>"""
    dynamo_db_stream_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_dynamo_db_stream_parameters.UpdatePipeSourceDynamoDBStreamParameters"
    ]
    """<p>The parameters for using a DynamoDB stream as a source.</p>"""
    sqs_queue_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_sqs_queue_parameters.UpdatePipeSourceSqsQueueParameters"
    ]
    """<p>The parameters for using a Amazon SQS stream as a source.</p>"""
    active_mq_broker_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_active_mq_broker_parameters.UpdatePipeSourceActiveMQBrokerParameters"
    ]
    """<p>The parameters for using an Active MQ broker as a source.</p>"""
    rabbit_mq_broker_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_rabbit_mq_broker_parameters.UpdatePipeSourceRabbitMQBrokerParameters"
    ]
    """<p>The parameters for using a Rabbit MQ broker as a source.</p>"""
    managed_streaming_kafka_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_managed_streaming_kafka_parameters.UpdatePipeSourceManagedStreamingKafkaParameters"
    ]
    """<p>The parameters for using an MSK stream as a source.</p>"""
    self_managed_kafka_parameters: NotRequired[
        "capo_pipes.types.update_pipe_source_self_managed_kafka_parameters.UpdatePipeSourceSelfManagedKafkaParameters"
    ]
    """<p>The parameters for using a self-managed Apache Kafka stream as a source.</p> <p>A <i>self managed</i> cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as <a href="https://www.confluent.io/">Confluent Cloud</a>, <a href="https://www.cloudkarafka.com/">CloudKarafka</a>, or <a href="https://redpanda.com/">Redpanda</a>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html">Apache Kafka streams as a source</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""

active_mq_broker_parameters instance-attribute

active_mq_broker_parameters: NotRequired[UpdatePipeSourceActiveMQBrokerParameters]

The parameters for using an Active MQ broker as a source.

dynamo_db_stream_parameters instance-attribute

dynamo_db_stream_parameters: NotRequired[UpdatePipeSourceDynamoDBStreamParameters]

The parameters for using a DynamoDB stream as a source.

filter_criteria instance-attribute

filter_criteria: NotRequired[FilterCriteria]

The collection of event patterns used to filter events.

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

kinesis_stream_parameters instance-attribute

kinesis_stream_parameters: NotRequired[UpdatePipeSourceKinesisStreamParameters]

The parameters for using a Kinesis stream as a source.

managed_streaming_kafka_parameters instance-attribute

managed_streaming_kafka_parameters: NotRequired[
    UpdatePipeSourceManagedStreamingKafkaParameters
]

The parameters for using an MSK stream as a source.

rabbit_mq_broker_parameters instance-attribute

rabbit_mq_broker_parameters: NotRequired[UpdatePipeSourceRabbitMQBrokerParameters]

The parameters for using a Rabbit MQ broker as a source.

self_managed_kafka_parameters instance-attribute

self_managed_kafka_parameters: NotRequired[UpdatePipeSourceSelfManagedKafkaParameters]

The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

sqs_queue_parameters instance-attribute

sqs_queue_parameters: NotRequired[UpdatePipeSourceSqsQueueParameters]

The parameters for using a Amazon SQS stream as a source.