DocumentDB - AWS Serverless Application Model
語法屬性範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

DocumentDB

描述DocumentDB事件來源類型的物件。如需詳細資訊，請參閱《 AWS Lambda 開發人員指南》中的搭配使用 AWS Lambda 與 Amazon DocumentDB。

語法

若要在 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 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 BatchSize 屬性。

Cluster

Amazon DocumentDB 叢集的 Amazon Resource Name (ARN)。

類型：字串

必要：是

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 EventSourceArn 屬性。

CollectionName

要在資料庫內使用的集合名稱。如果您未指定集合，Lambda 會使用所有集合。

類型：字串

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig 資料類型的 CollectionName 屬性。

DatabaseName

在 Amazon DocumentDB 叢集內使用的資料庫名稱。

類型：字串

必要：是

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig資料類型的 DatabaseName 屬性。

Enabled

如果為 true，則事件來源映射為作用中。若要暫停輪詢和調用，請將 設為 false。

類型：布林值

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 Enabled 屬性。

FilterCriteria

定義條件的物件，決定 Lambda 是否應處理事件。如需詳細資訊，請參閱《 AWS Lambda 開發人員指南》中的 Lambda 事件篩選。

類型：FilterCriteria

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 FilterCriteria 屬性。

FullDocument

決定 Amazon DocumentDB 在文件更新操作期間傳送到事件串流的內容。如果設定為 UpdateLookup，Amazon DocumentDB 會傳送描述變更的 Delta，以及整個文件的副本。否則，Amazon DocumentDB 只會傳送包含變更的部分文件。

類型：字串

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig 資料類型的 FullDocument 屬性。

KmsKeyArn

金鑰的 Amazon Resource Name (ARN)，用於加密與此事件相關的資訊。

類型：字串

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 KmsKeyArn 屬性。

MaximumBatchingWindowInSeconds

調用函式前收集記錄的最長時間 (單位為秒)。

類型：整數

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 MaximumBatchingWindowInSeconds 屬性。

SecretsManagerKmsKeyId

AWS Secrets Manager 的客戶受管金鑰的 AWS Key Management Service (AWS KMS) 金鑰 ID。當您使用 Secrets Manager 的客戶受管金鑰搭配不包含 kms:Decrypt 許可的 Lambda 執行角色時，此為必要項目。

此屬性的值是 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 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 SourceAccessConfigurations 屬性。

StartingPosition

要從中開始讀取的串流位置。

  • AT_TIMESTAMP – 指定從中開始讀取記錄的時間。

  • LATEST – 唯讀新記錄。

  • TRIM_HORIZON – 處理所有可用的記錄。

類型：字串

必要：是

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 StartingPosition 屬性。

StartingPositionTimestamp

開始讀取的時間，以 Unix 時間秒為單位。定義 StartingPositionTimestamp StartingPosition何時指定為 AT_TIMESTAMP。

類型：Double

必要：否

AWS CloudFormation 相容性：此屬性會直接傳遞至 AWS::Lambda::EventSourceMapping 資源的 StartingPositionTimestamp 屬性。

範例

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"