本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
EventBridgeRule
描述EventBridgeRule事件來源類型的物件,會將您的狀態機器設定為 Amazon EventBridge 規則的目標。如需詳細資訊,請參閱《Amazon EventBridge 使用者指南》中的什麼是 Amazon EventBridge?。
AWS SAM 會在設定此事件類型時產生AWS::Events::Rule資源。
語法
若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體,請使用下列語法。
YAML
DeadLetterConfig:DeadLetterConfigEventBusName:StringInput:StringInputPath:StringInputTransformer:InputTransformerPattern:EventPatternRetryPolicy:RetryPolicyRuleName:StringState:StringTarget:Target
屬性
-
DeadLetterConfig -
設定 Amazon Simple Queue Service (Amazon SQS) 佇列,EventBridge 會在目標呼叫失敗後傳送事件。例如,當將事件傳送至不存在的 Lambda 函數時,或當 EventBridge 沒有足夠的許可來叫用 Lambda 函數時,叫用可能會失敗。如需詳細資訊,請參閱《Amazon EventBridge 使用者指南》中的事件重試政策和使用無效字母佇列。
必要:否
CloudFormation 相容性:此屬性類似於
AWS::Events::RuleTarget資料類型的DeadLetterConfig屬性。此屬性的 AWS SAM 版本包含其他子屬性,以防您想要為您 AWS SAM 建立無效字母佇列。 -
EventBusName -
與此規則相關聯的事件匯流排。如果您省略此屬性, AWS SAM 會使用預設事件匯流排。
類型:字串
必要:否
預設:預設事件匯流排
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule資源的EventBusName屬性。 -
Input -
傳遞到目標的有效 JSON 文字。如果您使用此屬性,事件文字本身不會有任何內容傳遞到目標。
類型:字串
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule Target資源的Input屬性。 -
InputPath -
當您不想將整個相符事件傳遞至目標時,請使用
InputPath屬性來描述要傳遞的事件部分。類型:字串
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule Target資源的InputPath屬性。 InputTransformer-
此設定能讓您以特定事件資料為基礎,向目標提供自訂輸入。您可從事件擷取一或多組鍵/值對,然後使用該資料將自訂輸入傳送至目標。如需詳細資訊,請參閱《Amazon EventBridge 使用者指南》中的 Amazon EventBridge 輸入轉換。 EventBridge
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::RuleTarget資料類型的InputTransformer屬性。 -
Pattern -
說明哪些事件會路由到指定目標。如需詳細資訊,請參閱《Amazon EventBridge 使用者指南》中的 EventBridge 中的事件和事件模式。 EventBridge
類型:EventPattern
必要:是
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule資源的EventPattern屬性。 -
RetryPolicy -
包含重試政策設定相關資訊的
RetryPolicy物件。如需詳細資訊,請參閱《Amazon EventBridge 使用者指南》中的事件重試政策和使用無效字母佇列。類型:RetryPolicy
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::RuleTarget資料類型的RetryPolicy屬性。 -
RuleName -
規則的名稱。
類型:字串
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule資源的Name屬性。 State-
規則的狀態。
有效值:
[ DISABLED | ENABLED ]類型:字串
必要:否
CloudFormation 相容性:此屬性會直接傳遞至
AWS::Events::Rule資源的State屬性。 -
Target -
EventBridge 在觸發規則時呼叫 AWS 的資源。您可以使用此屬性來指定目標的邏輯 ID。如果未指定此屬性,則 AWS SAM 會產生目標的邏輯 ID。
類型:Target
必要:否
CloudFormation 相容性:此屬性類似於
AWS::Events::Rule資源的Targets屬性。此屬性的 AWS SAM 版本只允許您指定單一目標的邏輯 ID。
範例
EventBridgeRule
以下是EventBridgeRule事件來源類型的範例。
YAML
EBRule: Type: EventBridgeRule Properties: Input: '{"Key": "Value"}' Pattern: detail: state: - terminated