PipeTargetEventBridgeEventBusParameters

The parameters for using an EventBridge event bus as a target.

Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

Properties

Name Type Description
DetailType object
EndpointId object
Resources object
Source object
Time object
View JSON Schema on GitHub

JSON Schema

amazon-eventbridge-pipes-pipe-target-event-bridge-event-bus-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-target-event-bridge-event-bus-parameters-schema.json",
  "title": "PipeTargetEventBridgeEventBusParameters",
  "description": "The parameters for using an EventBridge event bus as a target.",
  "type": "object",
  "properties": {
    "DetailType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventBridgeDetailType"
        },
        {
          "description": "A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail."
        }
      ]
    },
    "EndpointId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventBridgeEndpointId"
        },
        {
          "description": "<p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p> <important> <p>When using Java, you must include <code>auth-crt</code> on the class path.</p> </important>"
        }
      ]
    },
    "Resources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventBridgeEventResourceList"
        },
        {
          "description": "Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present."
        }
      ]
    },
    "Source": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventBridgeEventSource"
        },
        {
          "description": "The source of the event."
        }
      ]
    },
    "Time": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonPath"
        },
        {
          "description": "The time stamp of the event, per <a href=\"https://www.rfc-editor.org/rfc/rfc3339.txt\">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href=\"https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html\">PutEvents</a> call is used."
        }
      ]
    }
  }
}