CloudWatchEvent - AWS Serverless Application Model
语法属性示例

CloudWatchEvent

描述 CloudWatchEvent 事件源类型的对象。

如果设置了此事件类型，AWS Serverless Application Model (AWS SAM) 会生成 AWS::Events::Rule 资源。

重要说明：EventBridgeRule 是首选使用的事件源类型，而不是 CloudWatchEvent。EventBridgeRule 和 CloudWatchEvent 使用相同的底层服务、API 和 CloudFormation 资源。但是，AWS SAM 将仅向 EventBridgeRule 添加对新功能的支持。

语法

要在您的 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。

YAML

  Enabled: Boolean
  EventBusName: String
  Input: String
  InputPath: String
  Pattern: EventPattern
  State: String

属性

Enabled

指示是否启用规则。

要禁用该规则，请将此属性设置为 false。

注意

指定 Enabled 或 State 属性，但不能同时指定两者。

类型：布尔值

必需：否

CloudFormation 兼容性：此属性类似于 AWS::Events::Rule 资源的 State 属性。如果此属性设置为 true，则 AWS SAM 传递 ENABLED，否则传递 DISABLED。

EventBusName

要与该规则关联的事件总线。如果省略此属性，则 AWS SAM 使用默认事件总线。

类型：字符串

必需：否

默认：默认事件总线

CloudFormation 兼容性：此属性直接传递给 AWS::Events::Rule 资源的 EventBusName 属性。

Input

传递到目标的有效 JSON 文本。如果使用此属性，则不会将事件文本本身的任何内容传递到目标。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::Events::Rule Target 资源的 Input 属性。

InputPath

当您不希望将整个匹配事件传递给目标时，请使用 InputPath 属性描述要传递事件的哪一部分。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::Events::Rule Target 资源的 InputPath 属性。

Pattern

描述哪些事件路由到指定目标。有关更多信息，请参阅《Amazon EventBridge 用户指南》中的 EventBridge 中的事件和事件模式。

类型：EventPattern

必需：是

CloudFormation 兼容性：此属性直接传递给 AWS::Events::Rule 资源的 EventPattern 属性。

State

规则的状态。

接受的值：DISABLED | ENABLED

注意

指定 Enabled 或 State 属性，但不能同时指定两者。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::Events::Rule 资源的 State 属性。

示例

CloudWatchEvent

以下是 CloudWatchEvent 事件源类型的示例。

YAML

CWEvent:
  Type: CloudWatchEvent
  Properties:
    Enabled: false
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running