Amazon EventBridge Pipes · JSON Structure

Amazon Eventbridge Pipes Pipe Enrichment Http Parameters Structure

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

Type: object Properties: 3
Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

PipeEnrichmentHttpParameters is a JSON Structure definition published by Amazon EventBridge Pipes, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

HeaderParameters PathParameterValues QueryStringParameters

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-structure/amazon-eventbridge-pipes-pipe-enrichment-http-parameters-structure.json",
  "name": "PipeEnrichmentHttpParameters",
  "description": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.",
  "type": "object",
  "properties": {
    "HeaderParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HeaderParametersMap"
        },
        {
          "description": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
        }
      ]
    },
    "PathParameterValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PathParameterList"
        },
        {
          "description": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."
        }
      ]
    },
    "QueryStringParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryStringParametersMap"
        },
        {
          "description": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
        }
      ]
    }
  }
}