DocumentDB - AWS Serverless Application Model
구문속성예시

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DocumentDB

DocumentDB 이벤트 소스 유형을 설명하는 객체. 자세한 내용은 AWS Lambda 개발자 안내서의 Amazon DocumentDB 의AWS Lambda 사용을 참조하세요.

구문

귀하의 AWS SAM 템플릿에서 이 객체를 선언하려면 다음 명령문을 사용합니다.

YAML

BatchSize: Integer
Cluster: String
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: FilterCriteria
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double

속성

BatchSize

한 번의 배치에서 검색하는 최대 항목 수입니다.

유형: 정수

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 BatchSize 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

Cluster

Amazon DocumentDB 클러스터의 Amazon 리소스 이름(ARN).

유형: 문자열

필수 항목 여부: 예

AWS CloudFormation호환성: 이 속성은 EventSourceArn 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

CollectionName

데이터베이스 내에서 사용할 컬렉션의 이름입니다. 컬렉션을 지정하지 않으면 Lambda는 모든 컬렉션을 사용합니다.

유형: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 CollectionName AWS::Lambda::EventSourceMapping 데이터 유형의 DocumentDBEventSourceConfig 속성에 직접 전달됩니다.

DatabaseName

Amazon DocumentDB 클러스터에서 사용할 데이터베이스의 이름.

유형: 문자열

필수 항목 여부: 예

AWS CloudFormation호환성: 이 속성은 DatabaseName AWS::Lambda::EventSourceMapping 데이터 유형의 DocumentDBEventSourceConfig 속성에 직접 전달됩니다.

Enabled

true이면, 이벤트 소스 매핑이 활성 상태입니다. 폴링 및 간접 호출을 일시 중지하려면 false로 설정합니다.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 Enabled 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

FilterCriteria

Lambda가 이벤트를 처리해야 하는지 결정하는 기준을 정의하는 객체입니다. 자세한 내용은 AWS Lambda개발자 안내서의 Lambda 이벤트 필터링을 참조하세요.

유형: FilterCriteria

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 FilterCriteria 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

FullDocument

문서 업데이트 작업 중에 Amazon DocumentDB가 귀하의 이벤트 스트림으로 보내는 내용을 결정합니다. UpdateLookup로 설정된 경우, Amazon DocumentDB는 전체 문서의 복사본과 함께 변경 내용을 설명하는 델타를 보냅니다. 그렇지 않으면 Amazon DocumentDB는 단지 변경 내용이 포함된 부분적 문서만 전송합니다.

유형: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 FullDocument AWS::Lambda::EventSourceMapping 데이터 유형의 DocumentDBEventSourceConfig 속성에 직접 전달됩니다.

KmsKeyArn

이 이벤트와 관련된 정보를 암호화하는 키의 Amazon 리소스 이름(ARN)입니다.

유형: 문자열

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 KmsKeyArn 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

MaximumBatchingWindowInSeconds

함수를 호출하기 전에 기록을 수집할 최대 기간(단위: 초)입니다.

유형: 정수

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 MaximumBatchingWindowInSeconds 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

SecretsManagerKmsKeyId

AWS Secrets Manager에서 제공하는 고객 관리 키의 AWS Key Management Service(AWS KMS) 키 ID. kms:Decrypt 권한이 포함되지 않은 Lambda 실행 역할과 함께 Secrets Manager의 고객 관리형 키를 사용할 때 필요합니다.

이 속성의 값은 UUID입니다. 예: 1abc23d4-567f-8ab9-cde0-1fab234c5d67.

유형: 문자열

필수 여부: 조건부

AWS CloudFormation호환성: 이 속성은 AWS SAM에 고유하며 AWS CloudFormation 동등한 속성이 없습니다.

SourceAccessConfigurations

인증 프로토콜 또는 가상 호스트의 배열입니다. SourceAccessConfigurations 데이터 유형을 사용하여 이를 지정하십시오.

DocumentDB이벤트 소스 유형의 경우 유효한 구성 유형은 BASIC_AUTH뿐입니다.

  • BASIC_AUTH - 귀하의 브로커 자격 증명을 저장하는 Secrets Manager 보안 암호입니다. 이 유형의 자격 증명은 다음 {"username": "your-username", "password": "your-password"} 형식이어야 합니다. BASIC_AUTH 유형의 객체는 오직 한 개만 허용됩니다.

유형: 목록

필수 항목 여부: 예

AWS CloudFormation호환성: 이 속성은 SourceAccessConfigurations 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

StartingPosition

읽기를 시작하는 스트림 내의 위치입니다.

  • AT_TIMESTAMP - 기록 읽기를 시작할 시간을 지정합니다.

  • LATEST – 새 기록만 읽습니다.

  • TRIM_HORIZON – 사용 가능한 모든 기록을 처리합니다.

유형: 문자열

필수 항목 여부: 예

AWS CloudFormation호환성: 이 속성은 StartingPosition 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

StartingPositionTimestamp

읽기를 시작하는 시간(유닉스 시간 초 단위)입니다. StartingPositionTimestamp 언제 StartingPosition를 AT_TIMESTAMP으로 지정할지 정의합니다.

유형: Double

필수 항목 여부: 아니요

AWS CloudFormation호환성: 이 속성은 StartingPositionTimestamp 리소스의 AWS::Lambda::EventSourceMapping 속성으로 직접 전달됩니다.

예시

Amazon DocumentDB 이벤트 소스

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
    ...
      Events:
        MyDDBEvent:
          Type: DocumentDB
          Properties:
            Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01"
            BatchSize: 10
            MaximumBatchingWindowInSeconds: 5
            DatabaseName: "db1"
            CollectionName: "collection1"
            FullDocument: "UpdateLookup"
            SourceAccessConfigurations:
              - Type: BASIC_AUTH
                URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db"