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

# DocumentDB
<a name="sam-property-function-documentdb"></a>

`DocumentDB` 이벤트 소스 유형을 설명하는 객체. 자세한 내용은 *AWS Lambda 개발자 안내서*의 [ Amazon DocumentDB AWS Lambda 에서 사용을](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) 참조하세요.

## 구문
<a name="sam-property-function-documentdb-syntax"></a>

 AWS SAM 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

### YAML
<a name="sam-property-function-documentdb-syntax-yaml"></a>

```
BatchSize: Integer
Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double
```

## 속성
<a name="sam-property-function-documentdb-properties"></a>

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
한 번의 배치에서 검색하는 최대 항목 수입니다.  
*유형*: 정수  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` 속성으로 직접 전달됩니다.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
Amazon DocumentDB 클러스터의 Amazon 리소스 이름(ARN).  
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` 속성으로 직접 전달됩니다.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
데이터베이스 내에서 사용할 컬렉션의 이름입니다. 컬렉션을 지정하지 않으면 Lambda는 모든 컬렉션을 사용합니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` 데이터 유형의 `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` 속성으로 직접 전달됩니다.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Amazon DocumentDB 클러스터에서 사용할 데이터베이스의 이름.  
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig`데이터 유형의 `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` 속성으로 직접 전달됩니다.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
`true`이면, 이벤트 소스 매핑이 활성 상태입니다. 폴링 및 간접 호출을 일시 중지하려면 `false`로 설정합니다.  
*유형*: 부울  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` 속성으로 직접 전달됩니다.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Lambda가 이벤트를 처리해야 하는지 결정하는 기준을 정의하는 객체입니다. 자세한 내용은 *AWS Lambda 개발자 안내서*의 [Lambda 이벤트 필터링](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)을 참조하세요.  
*유형*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` 속성으로 직접 전달됩니다.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
문서 업데이트 작업 중에 Amazon DocumentDB가 귀하의 이벤트 스트림으로 보내는 내용을 결정합니다. `UpdateLookup`로 설정된 경우, Amazon DocumentDB는 전체 문서의 복사본과 함께 변경 내용을 설명하는 델타를 보냅니다. 그렇지 않으면 Amazon DocumentDB는 단지 변경 내용이 포함된 부분적 문서만 전송합니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` 데이터 유형의 `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` 속성으로 직접 전달됩니다.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
이 이벤트와 관련된 정보를 암호화하는 키의 Amazon 리소스 이름(ARN)입니다.  
*유형*: 문자열  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` 속성으로 직접 전달됩니다.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
함수를 호출하기 전에 기록을 수집할 최대 기간(단위: 초)입니다.  
*유형*: 정수  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` 속성으로 직접 전달됩니다.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
 AWS Secrets Manager에서 고객 관리형 키의 AWS Key Management Service (AWS KMS) 키 ID입니다. `kms:Decrypt` 권한이 포함되지 않은 Lambda 실행 역할과 함께 Secrets Manager의 고객 관리형 키를 사용할 때 필요합니다.  
이 속성의 값은 UUID입니다. 예를 들어 `1abc23d4-567f-8ab9-cde0-1fab234c5d67`입니다.  
*유형*: 문자열  
*필수 항목 여부*: 조건부  
*CloudFormation 호환성*:이 속성은에 고유 AWS SAM 하며 동등한 속성이 CloudFormation 없습니다.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
인증 프로토콜 또는 가상 호스트의 배열입니다. [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html) 데이터 유형을 사용하여 이를 지정하십시오.  
`DocumentDB`이벤트 소스 유형의 경우 유효한 구성 유형은 `BASIC_AUTH`뿐입니다.  
+ `BASIC_AUTH` - 귀하의 브로커 자격 증명을 저장하는 Secrets Manager 보안 암호입니다. 이 유형의 자격 증명은 다음 `{"username": "your-username", "password": "your-password"}` 형식이어야 합니다. `BASIC_AUTH` 유형의 객체는 오직 한 개만 허용됩니다.
*유형*: 목록  
*필수 항목 여부*: 예  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` 속성으로 직접 전달됩니다.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
읽기를 시작하는 스트림 내의 위치입니다.  
+ `AT_TIMESTAMP` - 기록 읽기를 시작할 시간을 지정합니다.
+ `LATEST` – 새 기록만 읽습니다.
+ `TRIM_HORIZON` – 사용 가능한 모든 기록을 처리합니다.
*유형*: 문자열  
*필수 항목 여부:* 예  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` 속성으로 직접 전달됩니다.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
읽기를 시작하는 시간(유닉스 시간 초 단위)입니다. `StartingPositionTimestamp` 언제 `StartingPosition`를 `AT_TIMESTAMP`으로 지정할지 정의합니다.  
*유형*: Double  
*필수 항목 여부*: 아니요  
*CloudFormation 호환성*:이 속성은 `AWS::Lambda::EventSourceMapping` 리소스의 `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` 속성으로 직접 전달됩니다.

## 예제
<a name="sam-property-function-documentdb-examples"></a>

### Amazon DocumentDB 이벤트 소스
<a name="sam-property-function-documentdb-examples-example1"></a>

```
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"
```