DocumentDB - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DocumentDB

O objeto que descreve um tipo de fonte de evento DocumentDB. Para obter mais informações, consulte Uso do AWS Lambda com o Amazon DocumentDB no Guia do desenvolvedor do AWS Lambda.

Sintaxe

Para declarar esta entidade no modelo do AWS SAM, use a seguinte sintaxe:

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

Propriedades

BatchSize

O número máximo de itens a serem recuperados em um único lote.

Tipo: inteiro

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade BatchSize de um recurso AWS::Lambda::EventSourceMapping.

Cluster

O nome de recurso da Amazon (ARN) do cluster do Amazon DocumentDB.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade EventSourceArn de um recurso AWS::Lambda::EventSourceMapping.

CollectionName

O nome da coleção a ser consumida no banco de dados. Se você não especificar uma coleção, o Lambda consumirá todas as coleções.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade CollectionName de um tipo de dados AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig.

DatabaseName

O nome do banco de dados a ser usado no cluster do Amazon DocumentDB.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade DatabaseName de um tipo de dados AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig.

Enabled

Se true, o mapeamento da origem do evento estará ativo. Para pausar a sondagem e invocação, defina como false.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade Enabled de um recurso AWS::Lambda::EventSourceMapping.

FilterCriteria

Um objeto que define os critérios que determinam se o Lambda deve processar um evento. Para obter mais informações, consulte Filtrando eventos do Lambda no Guia do desenvolvedor do AWS Lambda.

Tipo: FilterCriteria

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade FilterCriteria de um recurso AWS::Lambda::EventSourceMapping.

FullDocument

Determina o que o Amazon DocumentDB enviará para seu fluxo de eventos durante as operações de atualização de documentos. Se estiver configurado para UpdateLookup, o Amazon DocumentDB enviará um delta descrevendo as alterações, junto com uma cópia de todo o documento. Senão, o Amazon DocumentDB enviará somente um documento parcial contendo as alterações.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade FullDocument de um tipo de dados AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig.

KmsKeyArn

O nome do recurso da Amazon (ARN) da chave para criptografar informações relacionadas a esse evento.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade KmsKeyArn de um recurso AWS::Lambda::EventSourceMapping.

MaximumBatchingWindowInSeconds

O máximo de tempo para reunir registros antes de invocar a função, em segundos.

Tipo: inteiro

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade MaximumBatchingWindowInSeconds de um recurso AWS::Lambda::EventSourceMapping.

SecretsManagerKmsKeyId

O ID da chave AWS Key Management Service (AWS KMS) de uma chave gerenciada pelo cliente do AWS Secrets Manager. Obrigatório quando você usa uma chave gerenciada pelo cliente do Secrets Manager com uma função de execução do Lambda que não inclui a permissãokms:Decrypt.

O valor da propriedade é um UUID. Por exemplo: 1abc23d4-567f-8ab9-cde0-1fab234c5d67.

Tipo: string

Obrigatório: Condicional

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

SourceAccessConfigurations

Uma matriz do protocolo de autenticação ou host virtual. Especifique isso usando o tipo de dados SourceAccessConfigurations.

Para o tipo de origem do evento DocumentDB, o único tipo de configuração válido é BASIC_AUTH.

  • BASIC_AUTH – O segredo do Secrets Manager que armazena as credenciais do agente. Para esse tipo, a credencial deverá estar no seguinte formato: {"username": "your-username", "password": "your-password"}. Somente um objeto do tipo BASIC_AUTH é permitido.

Tipo: lista

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade SourceAccessConfigurations de um recurso AWS::Lambda::EventSourceMapping.

StartingPosition

A posição em um fluxo da qual você deseja iniciar a leitura.

  • AT_TIMESTAMP – Especifique um tempo a partir do qual iniciar a leitura dos registros.

  • LATEST – Leia somente registros novos.

  • TRIM_HORIZON – Processe todos os registros disponíveis.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade StartingPosition de um recurso AWS::Lambda::EventSourceMapping.

StartingPositionTimestamp

O tempo a partir do qual iniciar a leitura, em segundos no horário do Unix. Defina StartingPositionTimestamp quando StartingPosition é especificado como .AT_TIMESTAMP

Tipo: duplo

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade StartingPositionTimestamp de um recurso AWS::Lambda::EventSourceMapping.

Exemplos

Origem do evento do 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"