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 ユーザーガイドの「Events andEvent Patterns in 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