Amazon EventBridge · JSON Structure

Amazon Eventbridge Rule Structure

Rule schema from Amazon EventBridge API

Type: object Properties: 8
Amazon Web ServicesEvent BusEvent-DrivenEventsIntegrationServerless

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

Properties

Name Arn EventPattern State Description ScheduleExpression RoleArn EventBusName

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/refs/heads/main/json-structure/amazon-eventbridge-rule-structure.json",
  "name": "Rule",
  "description": "Rule schema from Amazon EventBridge API",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "The name of the rule."
    },
    "Arn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the rule."
    },
    "EventPattern": {
      "type": "string",
      "description": "The event pattern of the rule."
    },
    "State": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "description": "The state of the rule."
    },
    "Description": {
      "type": "string",
      "description": "The description of the rule."
    },
    "ScheduleExpression": {
      "type": "string",
      "description": "The scheduling expression (e.g., cron or rate expression)."
    },
    "RoleArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the IAM role."
    },
    "EventBusName": {
      "type": "string",
      "description": "The name or ARN of the event bus associated with the rule."
    }
  }
}