PipeSourceParameters

The parameters required to set up a source for your pipe.

Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

Properties

Name Type Description
ActiveMQBrokerParameters object
DynamoDBStreamParameters object
FilterCriteria object
KinesisStreamParameters object
ManagedStreamingKafkaParameters object
RabbitMQBrokerParameters object
SelfManagedKafkaParameters object
SqsQueueParameters object
View JSON Schema on GitHub

JSON Schema

amazon-eventbridge-pipes-pipe-source-parameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-schema/amazon-eventbridge-pipes-pipe-source-parameters-schema.json",
  "title": "PipeSourceParameters",
  "description": "The parameters required to set up a source for your pipe.",
  "type": "object",
  "properties": {
    "ActiveMQBrokerParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceActiveMQBrokerParameters"
        },
        {
          "description": "The parameters for using an Active MQ broker as a source."
        }
      ]
    },
    "DynamoDBStreamParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceDynamoDBStreamParameters"
        },
        {
          "description": "The parameters for using a DynamoDB stream as a source."
        }
      ]
    },
    "FilterCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterCriteria"
        },
        {
          "description": "The collection of event patterns used to filter events. 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>."
        }
      ]
    },
    "KinesisStreamParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceKinesisStreamParameters"
        },
        {
          "description": "The parameters for using a Kinesis stream as a source."
        }
      ]
    },
    "ManagedStreamingKafkaParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceManagedStreamingKafkaParameters"
        },
        {
          "description": "The parameters for using an MSK stream as a source."
        }
      ]
    },
    "RabbitMQBrokerParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceRabbitMQBrokerParameters"
        },
        {
          "description": "The parameters for using a Rabbit MQ broker as a source."
        }
      ]
    },
    "SelfManagedKafkaParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceSelfManagedKafkaParameters"
        },
        {
          "description": "The parameters for using a self-managed Apache Kafka stream as a source."
        }
      ]
    },
    "SqsQueueParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipeSourceSqsQueueParameters"
        },
        {
          "description": "The parameters for using a Amazon SQS stream as a source."
        }
      ]
    }
  }
}