CloudWatchEvent - AWS Serverless Application Model
語法屬性範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CloudWatchEvent

描述CloudWatchEvent事件來源類型的物件。

AWS Serverless Application Model (AWS SAM) 在設定此事件類型時產生AWS::Events::Rule資源。

重要注意事項：EventBridgeRule是要使用的首選事件源類型，而不是CloudWatchEvent。 EventBridgeRule並CloudWatchEvent使用相同的基礎服務，API 和 AWS 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性質，但不能同時指定兩者。

類型：布林值

必要：否

AWS CloudFormation 兼容性：此屬性類似於AWS::Events::Rule資源的State屬性。如果此屬性設定為，true則 AWS SAM 傳遞ENABLED，否則會傳遞DISABLED。

EventBusName

與此規則相關聯的事件匯流排。如果您省略此屬性， AWS SAM 會使用預設事件匯流排。

類型：字串

必要：否

預設值：預設事件匯流排

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Events::Rule資源的EventBusName屬性。

Input

傳遞到目標的有效 JSON 文字。如果您使用此屬性，事件文字本身不會有任何內容傳遞到目標。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Events::Rule Target資源的Input屬性。

InputPath

如果您不想將整個匹配的事件傳遞給目標，請使用該InputPath屬性來描述要傳遞的事件的哪個部分。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Events::Rule Target資源的InputPath屬性。

Pattern

說明哪些事件會路由到指定目標。如需詳細資訊，請參閱 Amazon EventBridge 使用者指南 EventBridge中的事件和事件模式。

類型:EventPattern

必要：是

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Events::Rule資源的EventPattern屬性。

State

規則的狀態。

接受的值：DISABLED | ENABLED

注意

指定Enabled或State性質，但不能同時指定兩者。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Events::Rule資源的State屬性。

範例

CloudWatchEvent

以下是CloudWatchEvent事件來源類型的範例。

YAML

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