Interface EventBridgeRuleProps

Human-readable description of the EventBridge rule explaining its purpose and trigger conditions.

Use cases: Rule documentation; Operational clarity; Rule identification in console

AWS: EventBridge rule description displayed in the AWS console

Validation: Optional; free-form text

ARN of the custom EventBridge event bus where the rule should be created.

Use cases: Custom event bus routing; Cross-account event delivery; Dedicated event bus targeting

AWS: EventBridge custom event bus ARN for rule placement

Validation: Optional; must be a valid EventBridge event bus ARN if provided; defaults to the default event bus

EventBridge event pattern that defines which events should trigger the rule.

Use cases: Event filtering; Source-specific triggers; Detail-based matching; Custom event routing

AWS: EventBridge event pattern for rule matching and filtering

Validation: Optional; must be a valid EventBridge EventPattern if provided; mutually exclusive with scheduleExpression for some use cases

Custom input payload that will be provided to the rule target instead of the original event content.

Use cases: Custom target input; Event transformation; Static payload injection

AWS: EventBridge rule target input transformation

Validation: Optional; will be serialized as JSON input to the target

Schedule expression for time-based rule triggering using EventBridge cron or rate expressions.

Use cases: Scheduled processing; Periodic triggers; Cron-based automation; Rate-based execution

AWS: EventBridge schedule expression (cron or rate syntax)

Validation: Optional; must be a valid cron() or rate() expression if provided