AWS::Pipes::Pipe PipeSourceParameters
The parameters required to set up a source for your pipe.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ActiveMQBrokerParameters" :
PipeSourceActiveMQBrokerParameters
, "DynamoDBStreamParameters" :PipeSourceDynamoDBStreamParameters
, "FilterCriteria" :FilterCriteria
, "KinesisStreamParameters" :PipeSourceKinesisStreamParameters
, "ManagedStreamingKafkaParameters" :PipeSourceManagedStreamingKafkaParameters
, "RabbitMQBrokerParameters" :PipeSourceRabbitMQBrokerParameters
, "SelfManagedKafkaParameters" :PipeSourceSelfManagedKafkaParameters
, "SqsQueueParameters" :PipeSourceSqsQueueParameters
}
YAML
ActiveMQBrokerParameters:
PipeSourceActiveMQBrokerParameters
DynamoDBStreamParameters:PipeSourceDynamoDBStreamParameters
FilterCriteria:FilterCriteria
KinesisStreamParameters:PipeSourceKinesisStreamParameters
ManagedStreamingKafkaParameters:PipeSourceManagedStreamingKafkaParameters
RabbitMQBrokerParameters:PipeSourceRabbitMQBrokerParameters
SelfManagedKafkaParameters:PipeSourceSelfManagedKafkaParameters
SqsQueueParameters:PipeSourceSqsQueueParameters
Properties
ActiveMQBrokerParameters
-
The parameters for using an Active MQ broker as a source.
Required: No
Type: PipeSourceActiveMQBrokerParameters
Update requires: No interruption
DynamoDBStreamParameters
-
The parameters for using a DynamoDB stream as a source.
Required: No
Type: PipeSourceDynamoDBStreamParameters
Update requires: No interruption
FilterCriteria
-
The collection of event patterns used to filter events.
To remove a filter, specify a
FilterCriteria
object with an empty array ofFilter
objects.For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
Required: No
Type: FilterCriteria
Update requires: No interruption
KinesisStreamParameters
-
The parameters for using a Kinesis stream as a source.
Required: No
Type: PipeSourceKinesisStreamParameters
Update requires: No interruption
ManagedStreamingKafkaParameters
-
The parameters for using an MSK stream as a source.
Required: No
Type: PipeSourceManagedStreamingKafkaParameters
Update requires: No interruption
RabbitMQBrokerParameters
-
The parameters for using a Rabbit MQ broker as a source.
Required: No
Type: PipeSourceRabbitMQBrokerParameters
Update requires: No interruption
SelfManagedKafkaParameters
-
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 AWS. 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. Required: No
Type: PipeSourceSelfManagedKafkaParameters
Update requires: No interruption
SqsQueueParameters
-
The parameters for using a Amazon SQS stream as a source.
Required: No
Type: PipeSourceSqsQueueParameters
Update requires: No interruption