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 文檔數據庫集群的亞馬遜資源名稱（ARN）。

類型：字串

必要：是

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMapping資源的 EventSourceArn屬性。

CollectionName

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

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMappingDocumentDBEventSourceConfig數據類型的 CollectionName屬性。

DatabaseName

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

類型：字串

必要：是

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMappingDocumentDBEventSourceConfig數據類型的 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 會傳送描述變更的增量，以及整份文件的副本。否則，Amazon DocumentDB 只發送包含更改的部分文檔。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMappingDocumentDBEventSourceConfig數據類型的 FullDocument屬性。

KmsKeyArn

用於加密與此事件相關資訊的金鑰的 Amazon 資源名稱 (ARN)。

類型：字串

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMapping資源的KmsKeyArn屬性。

MaximumBatchingWindowInSeconds

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

類型：整數

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::Lambda::EventSourceMapping資源的 MaximumBatchingWindowInSeconds屬性。

SecretsManagerKmsKeyId

來自 AWS 秘密管理員的客戶管理金鑰的 AWS Key Management Service (AWS KMS) 金鑰識別碼。當您將來自秘密管理員的客戶管理金鑰與不包含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"