Docs / Contact / connectors/aws-eventbridge

AWS EventBridge

Provider: aws | Service: eventbridge | Direction: Write

Amazon EventBridge connector for putting events onto an event bus. This is a forward-only connector for event-driven architectures.

Required Permissions

Operation Required IAM Permissions
Put events events:PutEvents
Tip: Scope permissions to the specific event bus ARN to follow the principle of least privilege.

Operation

When a message reaches this connector, it publishes one event to the configured event bus. The payload must supply:

Payload field Required Description
source Yes Event source identifier
detail_type Yes Event detail type
detail Yes Event detail (JSON string)

Connector Configuration

The connector is created with type: "cloud", provider: "aws", service_type: "eventbridge", plus:

Field (config) Required Description
auth_type No api_key (default) or role for cross-account access. See below.
region No AWS region code. Derived automatically if event_bus_name is a full ARN.
access_key Conditional AWS access key. Required when auth_type is api_key.
secret_key Conditional AWS secret key. Required when auth_type is api_key.
event_bus_name Yes Event bus name or ARN
Role-based (cross-account) authentication

Set auth_type: "role" to assume an IAM role in your AWS account via STS. Provide role_arn (required) and optionally external_id. With role auth you do not supply access_key/secret_key.

Output

json

{
  "status": "completed",
  "statusCode": 200,
  "data": {
    "status": "published",
    "statusCode": 200,
    "method": "EVENTBRIDGE_PUT_EVENTS",
    "endpoint": "my-app-bus",
    "duration": 40,
    "response": { "event_bus": "my-app-bus", "source": "myapp.devices", "detailType": "DeviceEvent" }
  }
}

Example

Connector config (API key):

json

{
  "type": "cloud",
  "provider": "aws",
  "service_type": "eventbridge",
  "region": "us-east-1",
  "access_key": "${secrets.aws_access_key}",
  "secret_key": "${secrets.aws_secret_key}",
  "event_bus_name": "my-app-bus"
}

Connector config (cross-account role):

json

{
  "type": "cloud",
  "provider": "aws",
  "service_type": "eventbridge",
  "auth_type": "role",
  "region": "us-east-1",
  "role_arn": "arn:aws:iam::123456789012:role/contact-eventbridge",
  "event_bus_name": "my-app-bus"
}