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

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

Schedule

描述Schedule事件來源類型的物件，可將您的無伺服器函數設定為按排程觸發之 Amazon EventBridge 規則的目標。有關更多信息，請參閱什麼是 Amazon EventBridge？ 在 Amazon 用 EventBridge 戶指南。

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

注意

EventBridge 現在提供了一個新的排程功能，Amazon EventBridge Scheduler。Amazon EventBridge Scheduler 是無伺服器排程器，可讓您從單一中央受管服務建立、執行和管理任務。 EventBridge Scheduler具有高度可自訂性，並提供比 EventBridge 排程規則更高的可擴展性，並具有更廣泛的目標 API 操作和AWS 服務.

我們建議您使用 EventBridge Scheduler來呼叫排程的目標。若要在AWS SAM範本中定義此事件來源類型，請參閱ScheduleV2。

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

屬性

DeadLetterConfig

設定 Amazon Simple Queue Service (Amazon SQS) 佇列，在目標叫用失敗後 EventBridge 傳送事件。例如，當將事件傳送至不存在的 Lambda 函數，或是沒 EventBridge 有足夠的權限無法呼叫 Lambda 函數時，呼叫可能會失敗。如需詳細資訊，請參閱 Amazon 使用 EventBridge 者指南中的事件重試政策和使用無效字母佇列。

注意

資AWS::Serverless::Function源類型具有類似的資料類型DeadLetterQueue，可處理成功叫用目標 Lambda 函數之後發生的失敗。這些失敗類型的範例包括 Lambda 節流，或 Lambda 目標函數傳回的錯誤。如需有關函數DeadLetterQueue屬性的詳細資訊，請參閱AWS Lambda開發人員指南中的無效字母佇列。

類型:DeadLetterConfig

必要：否

AWS CloudFormation兼容性：此屬性類似於AWS::Events::RuleTarget數據類型的DeadLetterConfig屬性。如果您想要AWS SAM為您建立無效字母佇列，則此屬性的AWS SAM版本包含其他子屬性。

Description

規則的描述。

類型：字串

必要：否

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

Enabled

指出系統是否已啟用規則。

若要停用規則，請將此屬性設定為false。

注意

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

類型：布林值

必要：否

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

Input

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

類型：字串

必要：否

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

Name

規則的名稱。如果您未指定名稱，AWS CloudFormation 會產生唯一的實體 ID，並使用該 ID 做為規則名稱。

類型：字串

必要：否

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

RetryPolicy

包含重試政策設定相關資訊的 RetryPolicy 物件。如需詳細資訊，請參閱 Amazon 使用 EventBridge 者指南中的事件重試政策和使用無效字母佇列。

類型:RetryPolicy

必要：否

AWS CloudFormation兼容性：此屬性直接傳遞給AWS::Events::RuleTarget數據類型的RetryPolicy屬性。

Schedule

判斷何時及執行規則頻率的排程表達式。如需詳細資訊，請參閱規則的排程運算式。

類型：字串

必要：是

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

State

規則的狀態。

接受的值：DISABLED | ENABLED

注意

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

類型：字串

必要：否

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

範例

CloudWatch 排程活動

CloudWatch 排程事件範例

YAML

CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false