Spec-Zone.ru › AWS CLI v2

[ aws . lambda ]

создание-отображения-источника-событий

Описание

Создает отображение между источником событий и функцией Lambda. Lambda считывает элементы из источника событий и вызывает функцию.

Для получения подробной информации о конфигурации различных источников событий см. следующие разделы.

  • Amazon DynamoDB Streams
  • Amazon Kinesis
  • Amazon SQS
  • Amazon MQ и RabbitMQ
  • Amazon MSK
  • Apache Kafka
  • Amazon DocumentDB

Следующие параметры обработки ошибок доступны только для источников событий DynamoDB и Kinesis:

  • BisectBatchOnFunctionError – Если функция возвращает ошибку, разделите пакет на две части и повторите попытку.
  • MaximumRecordAgeInSeconds – Отбрасывать записи, старше указанного возраста. Значение по умолчанию – бесконечно (-1). При значении бесконечно (-1), проваленные записи повторно пытаются обработать до истечения срока действия записи.
  • MaximumRetryAttempts – Отбрасывать записи после указанного количества попыток. Значение по умолчанию – бесконечно (-1). При значении бесконечно (-1), проваленные записи повторно пытаются обработать до истечения срока действия записи.
  • ParallelizationFactor – Обрабатывать несколько пакетов из каждого сегмента одновременно.

Для источников потоков (DynamoDB, Kinesis, Amazon MSK и собственно управляемого Apache Kafka) также доступен следующий параметр:

  • DestinationConfig – Отправлять отброшенные записи в очередь Amazon SQS, тему Amazon SNS или ведро Amazon S3.

Для получения информации о том, какие параметры конфигурации применяются к каждому источнику событий, см. следующие разделы.

  • Amazon DynamoDB Streams
  • Amazon Kinesis
  • Amazon SQS
  • Amazon MQ и RabbitMQ
  • Amazon MSK
  • Apache Kafka
  • Amazon DocumentDB

См. также: Документация API AWS

Синтаксис

  create-event-source-mapping
[--event-source-arn <value>]
--function-name <value>
[--enabled | --no-enabled]
[--batch-size <value>]
[--filter-criteria <value>]
[--maximum-batching-window-in-seconds <value>]
[--parallelization-factor <value>]
[--starting-position <value>]
[--starting-position-timestamp <value>]
[--destination-config <value>]
[--maximum-record-age-in-seconds <value>]
[--bisect-batch-on-function-error | --no-bisect-batch-on-function-error]
[--maximum-retry-attempts <value>]
[--tags <value>]
[--tumbling-window-in-seconds <value>]
[--topics <value>]
[--queues <value>]
[--source-access-configurations <value>]
[--self-managed-event-source <value>]
[--function-response-types <value>]
[--amazon-managed-kafka-event-source-config <value>]
[--self-managed-kafka-event-source-config <value>]
[--scaling-config <value>]
[--document-db-event-source-config <value>]
[--kms-key-arn <value>]
[--metrics-config <value>]
[--provisioned-poller-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--event-source-arn (строка)

Идентификатор ресурса Amazon (ARN) источника событий.

  • Amazon Kinesis – ARN потока данных или потребителя потока.
  • Amazon DynamoDB Streams – ARN потока.
  • Amazon Simple Queue Service – ARN очереди.
  • Amazon Managed Streaming for Apache Kafka – ARN кластера или ARN подключения VPC (для отображений источника событий между аккаунтами).
  • Amazon MQ – ARN брокера.
  • Amazon DocumentDB – ARN потока изменений DocumentDB.

--function-name (строка)

Имя или ARN функции Lambda.

Форматы имён
  • Имя функции – MyFunction .
  • ARN функции – arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
  • ARN версии или алиаса – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .
  • Частичный ARN – 123456789012:function:MyFunction .

Ограничение длины применяется только к полному ARN. Если вы указываете только имя функции, оно ограничено 64 символами.

--enabled | --no-enabled (булево)

Если значение истинно, отображение источника событий активно. Если ложно, Lambda приостанавливает получение данных и вызов функции.

По умолчанию: Истина

--batch-size (целое число)

Максимальное количество записей в каждой группе, которые Lambda извлекает из потока или очереди и отправляет в вашу функцию. Lambda передаёт все записи в группе функции в одном вызове, до лимита загрузки для синхронного вызова (6 МБ).

  • Amazon Kinesis – По умолчанию 100. Максимум 10 000.
  • Amazon DynamoDB Streams – По умолчанию 100. Максимум 10 000.
  • Amazon Simple Queue Service – По умолчанию 10. Для стандартных очередей максимум 10 000. Для очередей FIFO максимум 10.
  • Amazon Managed Streaming for Apache Kafka – По умолчанию 100. Максимум 10 000.
  • Самостоятельно управляемый Apache Kafka – По умолчанию 100. Максимум 10 000.
  • Amazon MQ (ActiveMQ и RabbitMQ) – По умолчанию 100. Максимум 10 000.
  • DocumentDB – По умолчанию 100. Максимум 10 000.

--filter-criteria (структура)

Объект, определяющий критерии фильтрации, которые определяют, должна ли Lambda обрабатывать событие. Для получения дополнительной информации см. FilterCriteria">фильтрацию событий Lambda.

Фильтры -> (список)

Список фильтров.

(структура)

Структура в объекте FilterCriteria, определяющая шаблон фильтрации событий.

Шаблон -> (строка)

Шаблон фильтра. Для получения дополнительной информации о синтаксисе шаблона фильтра см. FilterCriteria">синтаксис правила фильтра.

Сокращённый синтаксис:

Filters=[{Pattern=string},{Pattern=string}]

Синтаксис JSON:

{
  "Filters": [
    {
      "Pattern": "string"
    }
    ...
  ]
}

--maximum-batching-window-in-seconds (целое число)

Максимальное время (в секундах), которое Lambda тратит на сбор записей перед вызовом функции. Вы можете настроить MaximumBatchingWindowInSeconds на любое значение от 0 до 300 секунд с шагом в секунды.

Для источников событий Kinesis, DynamoDB и Amazon SQS значение по умолчанию для интервала формирования группы — 0 секунд. Для источников событий Amazon MSK, самонастраиваемого Apache Kafka, Amazon MQ и DocumentDB значение по умолчанию — 500 мс. Обратите внимание, что вы можете изменять MaximumBatchingWindowInSeconds только с шагом в секунды, поэтому вы не можете вернуть значение по умолчанию 500 мс после его изменения. Чтобы восстановить значение по умолчанию для интервала формирования группы, необходимо создать новое отображение источника событий.

Связанное свойство: для источников событий Kinesis, DynamoDB и Amazon SQS, когда вы устанавливаете BatchSize на значение больше 10, вы должны установить MaximumBatchingWindowInSeconds по меньшей мере на 1.

--parallelization-factor (целое число)

(Только для Kinesis и DynamoDB Streams) Количество партий для одновременной обработки из каждого раздела.

--starting-position (строка)

Позиция в потоке, с которой следует начать чтение. Требуется для источников событий Amazon Kinesis и Amazon DynamoDB Stream. AT_TIMESTAMP поддерживается только для потоков Amazon Kinesis, Amazon DocumentDB, Amazon MSK и самонастраиваемого Apache Kafka.

Возможные значения:

  • TRIM_HORIZON
  • LATEST
  • AT_TIMESTAMP

--starting-position-timestamp (метка времени)

При установке StartingPosition на AT_TIMESTAMP время начала чтения. StartingPositionTimestamp не может быть в будущем.

--destination-config (структура)

(Только для Kinesis, DynamoDB Streams, Amazon MSK и самонастраиваемого Kafka) Объект конфигурации, который указывает место назначения события после его обработки Lambda.

OnSuccess -> (структура)

Настройка назначения для успешных вызовов.

Destination -> (строка)

Идентификатор ресурса Amazon (ARN) ресурса назначения.

OnFailure -> (структура)

Настройка назначения для неудачных вызовов.

Destination -> (строка)

Идентификатор ресурса Amazon (ARN) ресурса назначения.

Для сохранения записей об неудачных асинхронных вызовах вы можете настроить тему Amazon SNS, очередь Amazon SQS, ведро Amazon S3, функцию Lambda или шину событий Amazon EventBridge в качестве назначения.

Для сохранения записей об неудачных вызовах из Kinesis, DynamoDB, самонастраиваемого Kafka или Amazon MSK вы можете настроить тему Amazon SNS, очередь Amazon SQS или ведро Amazon S3 в качестве назначения.

Сокращённый синтаксис:

OnSuccess={Destination=string},OnFailure={Destination=string}

Синтаксис JSON:

{
  "OnSuccess": {
    "Destination": "string"
  },
  "OnFailure": {
    "Destination": "string"
  }
}

--maximum-record-age-in-seconds (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи старше указанного возраста. Значение по умолчанию — бесконечность (-1).

--bisect-batch-on-function-error | --no-bisect-batch-on-function-error (булево)

(Только для Kinesis и DynamoDB Streams) Если функция возвращает ошибку, разделить партию на две и повторить попытку.

--maximum-retry-attempts (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи после указанного количества попыток. Значение по умолчанию — бесконечность (-1). При значении бесконечность (-1) неудачные записи повторяются до истечения срока действия записи.

--tags (отображение)

Список тегов, применяемых к отображению источника событий.

ключ -> (строка)

значение -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--tumbling-window-in-seconds (целое число)

(Только для Kinesis и DynamoDB Streams) Длительность окна обработки в секундах для источников событий DynamoDB и Kinesis Streams. Значение 0 секунд означает отсутствие окна скользящего окна.

--topics (список)

Имя темы Kafka.

(строка)

Синтаксис:

"string" "string" ...

--queues (список)

(MQ) Название очереди назначения брокера Amazon MQ для потребления.

(строка)

Синтаксис:

"string" "string" ...

--source-access-configurations (список)

Массив протоколов аутентификации или компонентов VPC, необходимых для защиты вашего источника событий.

(структура)

Для защиты и определения доступа к вашему источнику событий вы можете указать протокол аутентификации, компоненты VPC или виртуальный хост.

Тип -> (строка)

Тип протокола аутентификации, компонентов VPC или виртуального хоста для вашего источника событий. Например: "Type":"SASL_SCRAM_512_AUTH" .

  • BASIC_AUTH – (Amazon MQ) Секрет Secrets Manager, хранящий данные о ваших учетных данных брокера.
  • BASIC_AUTH – (Самостоятельно управляемый Apache Kafka) ARN секрета Secrets Manager вашего секретного ключа, используемого для аутентификации SASL/PLAIN ваших брокер Apache Kafka.
  • VPC_SUBNET – (Самостоятельно управляемый Apache Kafka) Подсети, связанные с вашей VPC. Lambda подключается к этим подсетям для получения данных из вашего кластера Apache Kafka с самостоятельным управлением.
  • VPC_SECURITY_GROUP – (Самостоятельно управляемый Apache Kafka) Группа безопасности VPC, используемая для управления доступом к вашим брокерам Apache Kafka с самостоятельным управлением.
  • SASL_SCRAM_256_AUTH – (Самостоятельно управляемый Apache Kafka) ARN секрета Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-256 ваших брокер Apache Kafka.
  • SASL_SCRAM_512_AUTH – (Amazon MSK, Самостоятельно управляемый Apache Kafka) ARN секрета Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-512 ваших брокер Apache Kafka.
  • VIRTUAL_HOST – (RabbitMQ) Имя виртуального хоста в вашем брокере RabbitMQ. Lambda использует этот хост RabbitMQ в качестве источника событий. Это свойство нельзя указать в вызове API UpdateEventSourceMapping.
  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, самонастраиваемый Apache Kafka) ARN секрета Secrets Manager вашего секретного ключа, содержащего цепочку сертификатов (X.509 PEM), закрытый ключ (PKCS#8 PEM) и (необязательный) пароль к закрытому ключу, используемых для аутентификации взаимного TLS ваших брокер MSK/Apache Kafka.
  • SERVER_ROOT_CA_CERTIFICATE – (Самостоятельно управляемый Apache Kafka) ARN секрета Secrets Manager вашего секретного ключа, содержащего корневой сертификат CA (X.509 PEM), используемый для шифрования TLS ваших брокер Apache Kafka.

URI -> (строка)

Значение для выбранной конфигурации в Type . Например: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" .

Сокращённый синтаксис:

Type=string,URI=string ...

Синтаксис JSON:

[
  {
    "Type": "BASIC_AUTH"|"VPC_SUBNET"|"VPC_SECURITY_GROUP"|"SASL_SCRAM_512_AUTH"|"SASL_SCRAM_256_AUTH"|"VIRTUAL_HOST"|"CLIENT_CERTIFICATE_TLS_AUTH"|"SERVER_ROOT_CA_CERTIFICATE",
    "URI": "string"
  }
  ...
]

--self-managed-event-source (структура)

Кластер Apache Kafka с самостоятельным управлением, из которого будут получаться записи.

Endpoints -> (отображение)

Список серверов bootstrapping для ваших брокер Kafka в следующем формате: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] .

ключ -> (строка)

значение -> (список)

(строка)

Сокращённый синтаксис:

Endpoints={KeyName1=string,string,KeyName2=string,string}

Синтаксис JSON:

{
  "Endpoints": {"KAFKA_BOOTSTRAP_SERVERS": ["string", ...]
    ...}
}

--function-response-types (список)

(Kinesis, DynamoDB Streams и Amazon SQS) Список текущих типов ответов, применённых к отображению источника событий.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  ReportBatchItemFailures

--amazon-managed-kafka-event-source-config (структура)

Настройки конфигурации для источника событий Amazon Managed Streaming for Apache Kafka (Amazon MSK).

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka для присоединения. Идентификатор группы потребителей должен быть уникальным среди всех ваших источников событий Kafka. После создания отображения источника событий Kafka с указанным идентификатором группы потребителей вы не можете обновить это значение. Для получения дополнительной информации см. --amazon-managed-kafka-event-source-config">Идентификатор настраиваемой группы потребителей.

Сокращённый синтаксис:

ConsumerGroupId=string

Синтаксис JSON:

{
  "ConsumerGroupId": "string"
}

--self-managed-kafka-event-source-config (структура)

Конкретные параметры конфигурации для управляемого пользователем источника событий Apache Kafka.

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka для подключения. Идентификатор группы потребителей должен быть уникальным для всех ваших источников событий Kafka. После создания сопоставления источника событий Kafka с указанным идентификатором группы потребителей, вы не сможете обновить это значение. Дополнительную информацию см. в разделе Настраиваемый идентификатор группы потребителей.

Краткая запись:

ConsumerGroupId=string

Синтаксис JSON:

{
  "ConsumerGroupId": "string"
}

--scaling-config (структура)

(Только Amazon SQS) Настройка масштабирования для источника событий. Дополнительную информацию см. в разделе Настройка максимальной одновременной обработки для источников событий Amazon SQS.

MaximumConcurrency -> (целое число)

Ограничивает количество одновременных экземпляров, которые может вызывать источник событий Amazon SQS.

Краткая запись:

MaximumConcurrency=integer

Синтаксис JSON:

{
  "MaximumConcurrency": integer
}

--document-db-event-source-config (структура)

Конкретные параметры конфигурации для источника событий DocumentDB.

DatabaseName -> (строка)

Имя базы данных для потребления в кластере DocumentDB.

CollectionName -> (строка)

Имя коллекции для потребления в базе данных. Если вы не укажете коллекцию, Lambda потребляет все коллекции.

FullDocument -> (строка)

Определяет, что DocumentDB отправляет в ваш поток событий во время операций обновления документов. Если установлено значение UpdateLookup, DocumentDB отправляет дельту, описывающую изменения, а также копию всего документа. В противном случае DocumentDB отправляет только частичный документ, содержащий изменения.

Краткая запись:

DatabaseName=string,CollectionName=string,FullDocument=string

Синтаксис JSON:

{
  "DatabaseName": "string",
  "CollectionName": "string",
  "FullDocument": "UpdateLookup"|"Default"
}

--kms-key-arn (строка)

ARN управляемого клиентом ключа Key Management Service (KMS), который Lambda использует для шифрования критериев фильтрации вашей функции. По умолчанию Lambda не шифрует объект критериев фильтрации. Укажите этот параметр для шифрования данных с помощью собственного управляемого клиентом ключа.

--metrics-config (структура)

Настройка метрик для вашего источника событий. Дополнительную информацию см. в разделе Метрики сопоставления источников событий.

Metrics -> (список)

Метрики, которые вы хотите получать от вашего сопоставления источника событий. Включите EventCount, чтобы получать метрики сопоставления источника событий, относящиеся к количеству обработанных событий вашим сопоставлением источника событий. Дополнительную информацию об этих метриках см. в разделе Метрики сопоставления источников событий.

(строка)

Краткая запись:

Metrics=string,string

Синтаксис JSON:

{
  "Metrics": ["EventCount", ...]
}

--provisioned-poller-config (структура)

(Только Amazon MSK и управляемый пользователем Apache Kafka) Настройка режима предоставления ресурсов для источника событий. Дополнительную информацию см. в разделе Режим предоставления ресурсов.

MinimumPollers -> (целое число)

Минимальное количество элементов опроса событий, до которого может уменьшиться масштаб данного источника событий.

MaximumPollers -> (целое число)

Максимальное количество элементов опроса событий, до которого может увеличиться масштаб данного источника событий.

Краткая запись:

MinimumPollers=integer,MaximumPollers=integer

Синтаксис JSON:

{
  "MinimumPollers": integer,
  "MaximumPollers": integer
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команд.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла с данными учетных записей.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод CLI-пагинатора.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. Дополнительную информацию см. в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания сопоставления между источником событий и функцией AWS Lambda

Следующий пример create-event-source-mapping создает сопоставление между очередью SQS и функцией Lambda my-function.

aws lambda create-event-source-mapping \
    --function-name my-function \
    --batch-size 5 \
    --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue

Вывод:

{
    "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "StateTransitionReason": "USER_INITIATED",
    "LastModified": 1569284520.333,
    "BatchSize": 5,
    "State": "Creating",
    "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
    "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue"
}

Дополнительную информацию см. в разделе Сопоставление источника событий AWS Lambda в Руководстве разработчика AWS Lambda.

Вывод

UUID -> (строка)

Идентификатор источника событий.

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение. Требуется для источников событий Amazon Kinesis и Amazon DynamoDB Stream. AT_TIMESTAMP поддерживается только для потоков Amazon Kinesis, Amazon DocumentDB, Amazon MSK и самостоятельно управляемого Apache Kafka.

StartingPositionTimestamp -> (временная метка)

При значении StartingPosition, установленное как AT_TIMESTAMP, время, с которого начать чтение. StartingPositionTimestamp не может быть в будущем.

BatchSize -> (целое число)

Максимальное количество записей в каждой группе, которое Lambda извлекает из потока или очереди и отправляет вашей функции. Lambda передает все записи в группе функции в одном вызове, до предела полезной нагрузки для синхронного вызова (6 МБ).

Значение по умолчанию: Изменяется в зависимости от службы. Для Amazon SQS значение по умолчанию равно 10. Для всех остальных служб значение по умолчанию равно 100.

Связанное значение: Когда вы устанавливаете BatchSize на значение больше 10, вы должны установить MaximumBatchingWindowInSeconds как минимум на 1.

MaximumBatchingWindowInSeconds -> (целое число)

Максимальное время в секундах, которое Lambda тратит на сбор записей перед вызовом функции. Вы можете настроить MaximumBatchingWindowInSeconds на любое значение от 0 секунд до 300 секунд с шагом в секунды.

Для источников событий потоков и Amazon SQS значение по умолчанию для интервала группировки — 0 секунд. Для источников событий Amazon MSK, самостоятельно управляемого Apache Kafka, Amazon MQ и DocumentDB значение по умолчанию для интервала группировки — 500 мс. Обратите внимание, что поскольку вы можете изменять MaximumBatchingWindowInSeconds только с шагом в секунды, вы не можете вернуться к значению по умолчанию 500 мс после его изменения. Чтобы восстановить значение по умолчанию для интервала группировки, необходимо создать новый источник событий.

Связанное значение: Для источников событий потоков и Amazon SQS, когда вы устанавливаете BatchSize на значение больше 10, вы должны установить MaximumBatchingWindowInSeconds как минимум на 1.

ParallelizationFactor -> (целое число)

(Только для Kinesis и DynamoDB Streams) Количество партий для одновременной обработки из каждого фрагмента. Значение по умолчанию — 1.

EventSourceArn -> (строка)

Amazon Resource Name (ARN) источника событий.

FilterCriteria -> (структура)

Объект, определяющий критерии фильтрации, которые определяют, должна ли Lambda обрабатывать событие. Дополнительную информацию см. в разделе Фильтрация событий Lambda .

Если критерии фильтрации зашифрованы, это поле отображается как null в ответе API-вызовов ListEventSourceMapping. Вы можете просмотреть это поле в текстовом формате в ответах API-вызовов GetEventSourceMapping и DeleteEventSourceMapping, если у вас есть kms:Decrypt разрешения для соответствующего ключа KMS.

Filters -> (список)

Список фильтров.

(структура)

Структура в объекте FilterCriteria, определяющая шаблон фильтрации событий.

Pattern -> (строка)

Шаблон фильтра. Дополнительную информацию о синтаксисе шаблона фильтра см. в разделе Синтаксис правила фильтра.

FunctionArn -> (строка)

ARN функции Lambda.

LastModified -> (временная метка)

Дата последнего обновления источника событий или изменения его состояния.

LastProcessingResult -> (строка)

Результат последнего вызова функции Lambda.

State -> (строка)

Состояние источника событий. Может быть одним из следующих: Creating, Enabling, Enabled, Disabling, Disabled, Updating или Deleting.

StateTransitionReason -> (строка)

Указывает, пользователь или Lambda произвели последнее изменение в источнике событий.

DestinationConfig -> (структура)

(Только для источников событий Kinesis, DynamoDB Streams, Amazon MSK и самостоятельно управляемого Apache Kafka) Объект конфигурации, определяющий место назначения события после обработки Lambda.

OnSuccess -> (структура)

Конфигурация местоназначения для успешных вызовов.

Destination -> (строка)

Amazon Resource Name (ARN) ресурса назначения.

OnFailure -> (структура)

Конфигурация местоназначения для неудачных вызовов.

Destination -> (строка)

Amazon Resource Name (ARN) ресурса назначения.

Для сохранения записей об неудачных асинхронных вызовах вы можете настроить Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda функцию или Amazon EventBridge event bus в качестве места назначения.

Для сохранения записей об неудачных вызовах из Kinesis, DynamoDB, самостоятельно управляемого Kafka или Amazon MSK вы можете настроить Amazon SNS topic, Amazon SQS queue или Amazon S3 bucket в качестве места назначения.

Topics -> (список)

Имя темы Kafka.

(строка)

Queues -> (список)

(Amazon MQ) Имя очереди назначения Amazon MQ broker для потребления.

(строка)

SourceAccessConfigurations -> (список)

Массив протокола аутентификации, компонентов VPC или виртуального хоста для обеспечения безопасности и определения вашего источника событий.

(структура)

Для обеспечения безопасности и определения доступа к вашему источнику событий вы можете указать протокол аутентификации, компоненты VPC или виртуальный хост.

Type -> (строка)

Тип протокола аутентификации, компонентов VPC или виртуального хоста для вашего источника событий. Например: "Type":"SASL_SCRAM_512_AUTH".

  • BASIC_AUTH – (Amazon MQ) Секрет Secrets Manager, хранящий ваши учетные данные брокера.
  • BASIC_AUTH – (Самостоятельно управляемый Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL/PLAIN ваших брокеров Apache Kafka.
  • VPC_SUBNET – (Самостоятельно управляемый Apache Kafka) Подсети, связанные с вашей VPC. Lambda подключается к этим подсетям для извлечения данных из вашего кластера самолично управляемого Apache Kafka.
  • VPC_SECURITY_GROUP – (Самостоятельно управляемый Apache Kafka) Группа безопасности VPC, используемая для управления доступом к вашим брокерам самолично управляемого Apache Kafka.
  • SASL_SCRAM_256_AUTH – (Самостоятельно управляемый Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-256 ваших брокеров самолично управляемого Apache Kafka.
  • SASL_SCRAM_512_AUTH – (Amazon MSK, Самостоятельно управляемый Apache Kafka) ARN Secrets Manager вашего секретного ключа, используемого для аутентификации SASL SCRAM-512 ваших брокеров самолично управляемого Apache Kafka.
  • VIRTUAL_HOST – (RabbitMQ) Имя виртуального хоста в вашем брокере RabbitMQ. Lambda использует этот хост RabbitMQ как источник событий. Это свойство нельзя указать в вызове API UpdateEventSourceMapping.
  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, самолично управляемый Apache Kafka) ARN Secrets Manager вашего секретного ключа, содержащего цепочку сертификатов (X.509 PEM), закрытый ключ (PKCS#8 PEM) и пароль к закрытому ключу (необязательно), используемые для взаимной TLS-аутентификации ваших брокеров MSK/Apache Kafka.
  • SERVER_ROOT_CA_CERTIFICATE – (Самостоятельно управляемый Apache Kafka) ARN Secrets Manager вашего секретного ключа, содержащего корневой сертификат CA (X.509 PEM), используемый для шифрования TLS ваших брокеров Apache Kafka.

URI -> (строка)

Значение для выбранной вами конфигурации в Type. Например: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

SelfManagedEventSource -> (структура)

Кластер самолично управляемого Apache Kafka для вашего источника событий.

Endpoints -> (карта)

Список bootstrap-серверов для ваших брокеров Kafka в следующем формате: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].

key -> (строка)

value -> (список)

(строка)

MaximumRecordAgeInSeconds -> (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи, старше указанного возраста. Значение по умолчанию — -1, что устанавливает максимальный возраст в бесконечность. Когда значение установлено на бесконечность, Lambda никогда не отбрасывает старые записи.

Примечание

Минимальное допустимое значение для максимального возраста записи — 60 секунд. Хотя значения меньше 60 и больше -1 находятся в абсолютном диапазоне параметра, они недопустимы

BisectBatchOnFunctionError -> (булево)

(Только для Kinesis и DynamoDB Streams) Если функция возвращает ошибку, разделить партию на две и повторить попытку. Значение по умолчанию — false.

MaximumRetryAttempts -> (целое число)

(Только для Kinesis и DynamoDB Streams) Отбрасывать записи после указанного количества попыток повторной обработки. Значение по умолчанию — -1, что устанавливает максимальное количество попыток повторной обработки в бесконечность. Когда MaximumRetryAttempts равен бесконечности, Lambda пытается повторно обработать ошибочные записи, пока запись не истечет в источнике событий.

TumblingWindowInSeconds -> (целое число)

(Только для Kinesis и DynamoDB Streams) Длительность окна обработки в секундах для источников событий DynamoDB и Kinesis Streams. Значение 0 секунд означает отсутствие окна скользящего среднего.

FunctionResponseTypes -> (список)

(Kinesis, DynamoDB Streams и Amazon SQS) Список текущих типов ответов, применяемых к источнику событий.

(строка)

AmazonManagedKafkaEventSourceConfig -> (структура)

Настройки конфигурации для источника событий Amazon Managed Streaming for Apache Kafka (Amazon MSK).

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka для присоединения. Идентификатор группы потребителей должен быть уникальным среди всех ваших источников событий Kafka. После создания источника событий Kafka с указанным идентификатором группы потребителей вы не можете обновить это значение. Дополнительную информацию см. в разделе Настраиваемый идентификатор группы потребителей.

SelfManagedKafkaEventSourceConfig -> (структура)

Настройки конфигурации для источника событий самолично управляемого Apache Kafka.

ConsumerGroupId -> (строка)

Идентификатор группы потребителей Kafka для присоединения. Идентификатор группы потребителей должен быть уникальным среди всех ваших источников событий Kafka. После создания источника событий Kafka с указанным идентификатором группы потребителей вы не можете обновить это значение. Дополнительную информацию см. в разделе Настраиваемый идентификатор группы потребителей.

ScalingConfig -> (структура)

(Только для Amazon SQS) Конфигурация масштабирования для источника событий. Дополнительную информацию см. в разделе Настройка максимальной одновременности для источников событий Amazon SQS.

MaximumConcurrency -> (целое число)

Ограничивает количество одновременных экземпляров, которые может вызывать источник событий Amazon SQS.

DocumentDBEventSourceConfig -> (структура)

Настройки конфигурации для источника событий DocumentDB.

DatabaseName -> (строка)

Имя базы данных для потребления в кластере DocumentDB.

CollectionName -> (строка)

Имя коллекции для потребления в базе данных. Если вы не указываете коллекцию, Lambda потребляет все коллекции.

FullDocument -> (строка)

Определяет, что DocumentDB отправляет в ваш поток событий во время операций обновления документов. Если установлено значение UpdateLookup, DocumentDB отправляет дельту, описывающую изменения, вместе с копией всего документа. В противном случае DocumentDB отправляет только частичный документ, содержащий изменения.

KMSKeyArn -> (string)

Уникальный идентификатор (ARN) управляемого клиентом ключа службы управления ключами KMS (Key Management Service), который Lambda использует для шифрования критериев фильтра вашей функции.

FilterCriteriaError -> (structure)

Объект, содержащий подробности об ошибке, связанной с шифрованием критериев фильтра.

ErrorCode -> (string)

Исключение KMS, возникшее в результате шифрования или дешифрования критериев фильтра.

Message -> (string)

Сообщение об ошибке.

EventSourceMappingArn -> (string)

Уникальный идентификатор ресурса Amazon (ARN) сопоставления источника событий.

MetricsConfig -> (structure)

Настройка метрик для вашего источника событий. Дополнительную информацию см. в разделе Метрики сопоставления источника событий.

Metrics -> (list)

Метрики, которые вы хотите получать от сопоставления источника событий. Включите EventCount, чтобы получить метрики сопоставления источника событий, относящиеся к количеству обработанных событий вашим сопоставлением источника событий. Дополнительную информацию о метриках см. в разделе Метрики сопоставления источника событий.

(string)

ProvisionedPollerConfig -> (structure)

(Только для Amazon MSK и собственного Apache Kafka) Настройка режима предоставления ресурсов для источника событий. Дополнительную информацию см. в разделе режим предоставления ресурсов.

MinimumPollers -> (integer)

Минимальное количество опрошивателей событий, до которого может уменьшиться масштабирование этого источника событий.

MaximumPollers -> (integer)

Максимальное количество опрошивателей событий, до которого может увеличиться масштабирование этого источника событий.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API