CloudWatchEvent

CloudWatchEvent イベントソースタイプを説明するオブジェクトです。

AWS Serverless Application Model （AWS SAM) このイベントタイプが設定されると、 は AWS::Events::Ruleリソースを生成します。

重要な注意点: EventBridgeRuleは、 ではなく、優先するイベントソースタイプですCloudWatchEvent。 EventBridgeRuleおよび は、同じ基盤となるサービス、API、 AWS CloudFormation リソースCloudWatchEventを使用します。ただし、 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プロパティに似ています。このプロパティが に設定されている場合、 AWS SAM を渡trueします。それ以外の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