EventBridgeRuleConfig

Defined in: packages/core/src/config/types.ts:695

Config shape for declaring an EventBridge rule. Exactly one of eventPattern / schedule must be set (AtfEventBridge throws [Axis] otherwise).

Properties

constructId

constructId: string

Defined in: packages/core/src/config/types.ts:697

CFN logical ID — NEVER change once deployed.

---

description?

optional description?: string

Defined in: packages/core/src/config/types.ts:706

---

enabled?

optional enabled?: boolean

Defined in: packages/core/src/config/types.ts:708

Default true.

---

eventBusName?

optional eventBusName?: string

Defined in: packages/core/src/config/types.ts:705

baseName of a declared EventBusConfig; default bus when omitted.

---

eventPattern?

optional eventPattern?: Record<string, unknown>

Defined in: packages/core/src/config/types.ts:701

EventBridge pattern JSON. Exactly one of eventPattern / schedule must be set.

---

ruleName

ruleName: string

Defined in: packages/core/src/config/types.ts:699

Physical rule name = ${ruleName}-${stageName}.

---

schedule?

optional schedule?: string

Defined in: packages/core/src/config/types.ts:703

Cron/rate schedule expression, e.g. “rate(1 hour)” / “cron(0 12 * * ? *)”.