EventBridgeRule

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

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

구문

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

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: InputTransformer
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  RuleName: String 
  State: String
  Target: Target

속성

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

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 속성에 직접 전달됩니다.

InputTransformer

특정 이벤트 데이터를 기반으로 대상에 사용자 지정 입력을 제공할 수 있게 하는 설정입니다. 이벤트에서 하나 이상의 키-값 페어를 추출한 후 이 데이터를 사용하여 대상에 사용자 지정 입력을 전송할 수 있습니다. 자세한 내용은 Amazon EventBridge 사용 설명서의 Amazon EventBridge 입력 변환을 참조하십시오.

유형: InputTransformer

필수 항목 여부: 아니요

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

Pattern

어떤 이벤트가 지정된 대상으로 라우팅되는지를 설명합니다. 자세한 내용은 Amazon EventBridge 사용 설명서의 Amazon EventBridge EventBridge 이벤트 및 이벤트 패턴을 참조하십시오.

유형: EventPattern

필수 항목 여부: 예

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

RetryPolicy

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

유형: RetryPolicy

필수 항목 여부: 아니요

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

RuleName

규칙의 이름입니다.

타입: 문자열

필수 항목 여부: 아니요

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

State

규칙의 상태입니다.

허용되는 값:: DISABLED | ENABLED

타입: 문자열

필수 항목 여부: 아니요

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

Target

규칙이 트리거될 때 EventBridge 호출되는 AWS 리소스입니다. 이 속성을 사용하여 대상의 논리적 ID를 지정할 수 있습니다. 이 속성을 지정하지 않으면 대상의 논리적 ID를 AWS SAM 생성합니다.

유형: Target

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::Events::Rule 리소스의 Targets 속성과 유사합니다. 이 속성의 AWS SAM 버전에서는 단일 대상의 논리적 ID만 지정할 수 있습니다.

예

EventBridgeRule

다음은 EventBridgeRule 이벤트 소스 유형의 예입니다.

YAML

EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget