翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 ユーザーガイドの「Events andEvent Patterns in 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