ScheduleV2

ScheduleV2이벤트 소스 유형을 설명하는 객체로, 일정에 따라 트리거되는 Amazon EventBridge Scheduler 이벤트의 대상으로 상태 머신을 설정합니다. 자세한 내용은 Amazon EventBridge 스케줄러란 무엇입니까? 를 참조하십시오. EventBridge 스케줄러 사용 설명서에서.

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

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

DeadLetterConfig: DeadLetterConfig
Description: String
EndDate: String
FlexibleTimeWindow: FlexibleTimeWindow
GroupName: String
Input: String
KmsKeyArn: String
Name: String
OmitName: Boolean
PermissionsBoundary: String
RetryPolicy: RetryPolicy
RoleArn: String
ScheduleExpression: String
ScheduleExpressionTimezone: String
StartDate: String
State: String

속성

DeadLetterConfig

대상 호출 실패 후 이벤트를 전송하는 Amazon Simple Queue 서비스 (Amazon SQS) 대기열을 EventBridge 구성합니다. 예를 들어 존재하지 않는 Lambda 함수로 이벤트를 전송하거나 Lambda 함수를 EventBridge 호출할 권한이 충분하지 않은 경우 호출이 실패할 수 있습니다. 자세한 내용은 스케줄러 사용 설명서의 스케줄러를 위한 데드레터 대기열 구성을 참조하십시오. EventBridge EventBridge

유형: DeadLetterConfig

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule Target 데이터 유형의 DeadLetterConfig 속성과 유사합니다. 데드 레터 큐를 자동으로 AWS SAM 만들려는 경우를 대비하여 이 속성의 AWS SAM 버전에는 추가 하위 속성이 포함되어 있습니다.

Description

일정에 대한 설명입니다.

타입: 문자열

필수 항목 여부: 아니요

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

EndDate

일정이 대상을 간접 호출할 수 있는 날짜(UTC 기준)입니다. 일정의 반복 식에 따라 사용자가 지정하는 EndDate 또는 그 이전에 호출이 중지될 수 있습니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 EndDate 속성에 직접 전달됩니다.

FlexibleTimeWindow

일정을 간접 호출할 수 있는 창을 구성할 수 있습니다.

유형: FlexibleTimeWindow

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 FlexibleTimeWindow 속성으로 직접 전달됩니다.

GroupName

이 일정과 연계하기 위한 일정 그룹의 이름입니다. 정의되지 않은 경우 기본 그룹이 사용됩니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 GroupName 속성에 직접 전달됩니다.

Input

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

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule Target 리소스의 Input 속성에 직접 전달됩니다.

KmsKeyArn

고객 데이터를 암호화하는 데 사용되는 KMS 키의 ARN.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 KmsKeyArn 속성에 직접 전달됩니다.

Name

일정의 이름입니다. 이름을 지정하지 않는 경우 는 해당 형식으로 StateMachine-Logical-IDEvent-Source-Name 이름을 AWS SAM 생성하고 해당 ID를 일정 이름으로 사용합니다.

타입: 문자열

필수 항목 여부: 아니요

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

OmitName

기본적으로 <S tate-machine-logical event-source-name -ID>< > 형식으로 스케줄 이름을 AWS SAM 생성하여 사용합니다. 고유한 물리적 ID를 true AWS CloudFormation 생성하도록 이 속성을 설정하고 이 ID를 스케줄 이름으로 대신 사용하십시오.

유형: 부울

필수 항목 여부: 아니요

기본값: false

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

PermissionsBoundary

역할에 대한 권한 경계 설정에 사용되는 정책의 ARN입니다.

참고

PermissionsBoundary가 정의된 경우 AWS SAM 스케줄러 일정의 대상 IAM 역할에 동일한 경계를 적용합니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 리소스의 PermissionsBoundary 속성에 직접 전달됩니다. AWS::IAM::Role

RetryPolicy

재시도 정책 설정에 대한 정보가 포함된 RetryPolicy 객체입니다.

유형: RetryPolicy

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule Target 데이터 유형의 RetryPolicy 속성으로 직접 전달됩니다.

RoleArn

스케줄이 호출될 때 EventBridge 스케줄러가 타겟에 사용할 IAM 역할의 ARN입니다.

유형: RoleArn

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule Target 데이터 유형의 RoleArn 속성으로 직접 전달됩니다.

ScheduleExpression

일정 실행 시기 및 방법을 결정하는 예약 표현식입니다.

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 ScheduleExpression 속성에 직접 전달됩니다.

ScheduleExpressionTimezone

스케줄링 표현식이 평가되는 시간대입니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 ScheduleExpressionTimezone 속성에 직접 전달됩니다.

StartDate

일정이 대상의 간접 호출을 시작할 수 있는 날짜(UTC 기준)입니다. 일정의 반복 식에 따라 사용자가 지정하는 StartDate 또는 그 이후에 호출이 발생할 수 있습니다.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 StartDate 속성에 직접 전달됩니다.

State

일정 상태

허용되는 값:DISABLED | ENABLED

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Scheduler::Schedule 리소스의 State 속성에 직접 전달됩니다.

예

ScheduleV2 리소스를 정의하는 기본 예제

StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    Events:
      ScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: "rate(1 minute)"
      ComplexScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: rate(1 minute)
          FlexibleTimeWindow:
            Mode: FLEXIBLE
            MaximumWindowInMinutes: 5
          StartDate: '2022-12-28T12:00:00.000Z'
          EndDate: '2023-01-28T12:00:00.000Z'
          ScheduleExpressionTimezone: UTC
          RetryPolicy:
            MaximumRetryAttempts: 5
            MaximumEventAgeInSeconds: 300
          DeadLetterConfig:
            Type: SQS
    DefinitionUri:
      Bucket: sam-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction