Rule

Rule schema from Amazon EventBridge API

Amazon Web ServicesEvent BusEvent-DrivenEventsIntegrationServerless

Properties

Name	Type	Description
Name	string	The name of the rule.
Arn	string	The Amazon Resource Name (ARN) of the rule.
EventPattern	string	The event pattern of the rule.
State	string	The state of the rule.
Description	string	The description of the rule.
ScheduleExpression	string	The scheduling expression (e.g., cron or rate expression).
RoleArn	string	The Amazon Resource Name (ARN) of the IAM role.
EventBusName	string	The name or ARN of the event bus associated with the rule.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge/refs/heads/main/json-schema/amazon-eventbridge-rule-schema.json",
  "title": "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."
    }
  }
}