Schedule

Schedule이벤트 소스 유형을 설명하는 객체로, 서버리스 함수를 일정에 따라 트리거되는 Amazon EventBridge 규칙의 대상으로 설정합니다. 자세한 내용은 Amazon이란 무엇입니까 EventBridge? 를 참조하십시오. Amazon EventBridge 사용 설명서에서 확인할 수 있습니다.

AWS Serverless Application Model(AWS SAM)은 이 이벤트 유형이 설정되면 AWS::Events::Rule리소스를 생성합니다.

참고

EventBridge 이제 새로운 예약 기능인 EventBridge SchedulerAmazon을 제공합니다. EventBridge SchedulerAmazon은 하나의 중앙 관리형 서비스에서 작업을 생성, 실행 및 관리할 수 있는 서버리스 스케줄러입니다. EventBridge Scheduler고도로 사용자 지정이 가능하며, 대상 API 작업 범위가 더 넓어 EventBridge 예정된 규칙보다 향상된 확장성을 제공합니다. 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 서비스 (Amazon SQS) 대기열을 EventBridge 구성합니다. 예를 들어 존재하지 않는 Lambda 함수로 이벤트를 전송하거나 Lambda 함수를 EventBridge 호출할 권한이 충분하지 않은 경우 호출이 실패할 수 있습니다. 자세한 내용은 Amazon 사용 설명서의 이벤트 재시도 정책 및 데드레터 대기열 사용을 참조하십시오. EventBridge

참고

AWS::Serverless::Function 리소스 유형에는 유사한 데이터 유형인DeadLetterQueue가 있으며, 이는 대상 Lambda 함수를 성공적으로 호출한 후 발생하는 장애를 처리합니다. 이러한 유형의 실패의 예로는 Lambda 제한 또는 Lambda 대상 함수에서 표시되는 오류가 있습니다. 함수 DeadLetterQueue 속성에 대한 자세한 내용은 AWS Lambda 개발자 가이드의 DLQ(Dead Letter Queue)를 참조하세요.

유형: DeadLetterConfig

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 DeadLetterConfig 데이터 유형의 AWS::Events::Rule Target 속성과 유사합니다. DLQ를 자동으로 AWS SAM 생성하고자 하는 경우에 대비하여 이 속성의 AWS SAM 버전에는 추가 하위 속성이 포함되어 있습니다.

Description

규칙에 대한 설명.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 Description 리소스의 AWS::Events::Rule 속성으로 직접 전달됩니다.

Enabled

규칙을 활성화할지를 나타냅니다.

규칙을 비활성화하려면 이 속성을 false로 설정합니다.

참고

Enabled 또는 State 속성을 지정할 수 있지만, 두 속성을 함께 지정할 수는 없습니다.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 State 리소스의 AWS::Events::Rule 속성과 유사합니다. 이 속성이 true로 설정되면 AWS SAM가 ENABLED로 전달되고, 그렇지 않으면 DISABLED로 전달됩니다.

Input

대상으로 전달되는 유효한 JSON 텍스트입니다. 이 속성을 사용하면 이벤트 텍스트 자체의 어떤 것도 대상으로 전달되지 않습니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 Input 리소스의 AWS::Events::Rule Target 속성으로 직접 전달됩니다.

Name

규칙의 이름입니다. 이름을 지정하지 않은 경우 AWS CloudFormation은 고유한 물리적 ID를 생성한 후 규칙 이름에 해당 ID를 사용합니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 Name 리소스의 AWS::Events::Rule 속성으로 직접 전달됩니다.

RetryPolicy

재시도 정책 설정에 대한 정보가 포함된 RetryPolicy 객체입니다. 자세한 내용은 Amazon 사용 설명서의 이벤트 재시도 정책 및 데드레터 대기열 사용을 참조하십시오. EventBridge

유형: RetryPolicy

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 RetryPolicy AWS::Events::Rule 데이터 유형의 Target 속성에 직접 전달됩니다.

Schedule

규칙 실행 시기 및 방법을 결정하는 스케줄링 표현식입니다. 자세한 내용은 규칙에 대한 예약 표현식을 참조하세요.

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation호환성: 이 속성은 ScheduleExpression 리소스의 AWS::Events::Rule 속성으로 직접 전달됩니다.

State

규칙의 상태입니다.

허용되는 값: DISABLED | ENABLED

참고

Enabled 또는 State 속성을 지정할 수 있지만, 두 속성을 함께 지정할 수는 없습니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 State 리소스의 AWS::Events::Rule 속성으로 직접 전달됩니다.

예제

CloudWatch 일정 이벤트

CloudWatch 스케줄 이벤트 예제

YAML

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