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 との互換性: このプロパティは、AWS::Lambda::EventSourceMapping リソースの BatchSize プロパティに直接渡されます。

Cluster

Amazon DocumentDB クラスターの Amazon リソースネーム (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 は、ドキュメント全体のコピーとともに、変更について記述するデルタを送信します。それ以外の場合、Amazon DocumentDB は、変更を含む部分的なドキュメントのみを送信します。

型: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig データ型の FullDocument プロパティに直接渡されます。

KmsKeyArn

このイベントに関連する情報を暗号化するためのキーの Amazon リソースネーム (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。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 タイプのオブジェクトが 1 つだけ許可されます。

タイプ: リスト

必須: はい

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventSourceMapping リソースの SourceAccessConfigurations プロパティに直接渡されます。

StartingPosition

読み取りを開始するストリームの場所です。

  • AT_TIMESTAMP - レコードの読み取りを開始する時間を指定します。

  • LATEST - 新しいレコードのみを読み込みます。

  • TRIM_HORIZON - 使用可能なすべてのレコードを処理します。

型: 文字列

必須: はい

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventSourceMapping リソースの StartingPosition プロパティに直接渡されます。

StartingPositionTimestamp

Unix タイム秒単位で読み取りをスタートする時間。StartingPosition が AT_TIMESTAMP として指定されている場合の StartingPositionTimestamp を定義します。

型: 倍精度

必須: いいえ

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"