Модуль amazon.aws.lambda_event – создание, обновление и удаление сопоставлений источников событий функций AWS Lambda

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.lambda_event.

Добавлено в amazon.aws 5.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет управлять сопоставлениями источников событий функций AWS Lambda, например событиями потоков DynamoDB и Kinesis, с помощью платформы Ansible. Эти сопоставления источников событий актуальны только для модели опроса AWS Lambda, в которой AWS Lambda вызывает функцию. Модуль идемпотентен и поддерживает режим «Проверка». Используйте модуль amazon.aws.lambda для управления самой функцией Lambda, а amazon.aws.lambda_alias — для управления псевдонимами функций.
Этот модуль впервые появился в community.aws в выпуске 1.0.0.

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
alias строка	Имя псевдонима функции. Взаимоисключающий параметр с `version`.
aws_ca_bundle путь	Путь к пакету CA-сертификатов, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логический	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в рамках плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
event_source строка	Источник события, запускающего функцию Lambda. Для событий DynamoDB и Kinesis выберите `stream`. Для очередей SQS выберите `sqs`. Варианты: `"stream"` ← (по умолчанию) `"sqs"`
lambda_function_arn псевдонимы: function_name, function_arn строка / обязательный	Имя или ARN функции Lambda.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
source_params словарь / обязательный	Дополнительные параметры, необходимые для источника события.
batch_size целое число	Максимальное количество записей, которые AWS Lambda получает из источника событий при вызове функции. Amazon Kinesis — значение по умолчанию `100`. Максимум `10000`. Amazon DynamoDB Streams — значение по умолчанию `100`. Максимум `10000`. Amazon Simple Queue Service — значение по умолчанию `10`. Для стандартных очередей максимум составляет `10000`. Для очередей FIFO максимум составляет `10`. Amazon Managed Streaming for Apache Kafka — значение по умолчанию `100`. Максимум `10000`. Apache Kafka с самостоятельным управлением — значение по умолчанию `100`. Максимум `10000`. Amazon MQ (ActiveMQ и RabbitMQ) — значение по умолчанию `100`. Максимум `10000`. DocumentDB — значение по умолчанию `100`. Максимум `10000`.
enabled логический	Указывает, должна ли AWS Lambda начать опрос или чтение источника событий. Варианты: `false` `true` ← (по умолчанию)
function_response_types список / элементы=строка добавлено в amazon.aws 5.5.0	(Потоки и Amazon SQS) Список текущих перечислимых типов ответа, применяемых к сопоставлению источника событий. Варианты: `"ReportBatchItemFailures"`
maximum_batching_window_in_seconds целое число добавлено в amazon.aws 8.0.0	Максимальное время в секундах, в течение которого Lambda собирает записи перед вызовом функции. Для `source_params.maximum_batching_window_in_seconds` можно задать любое значение от `0` секунд до `300` секунд с шагом в одну секунду. Для потоков и источников событий Amazon SQS, если для `source_params.batch_size` задано значение больше `10`, значение `source_params.maximum_batching_window_in_seconds` по умолчанию равно `1`. `source_params.maximum_batching_window_in_seconds` не поддерживается очередями FIFO.
source_arn строка / обязательный	Имя ресурса Amazon (ARN) очереди SQS, потока Kinesis или потока DynamoDB, являющегося источником события.
starting_position строка	Позиция в потоке, с которой AWS Lambda должна начать чтение. Обязателен, если `event_source=stream`. Варианты: `"TRIM_HORIZON"` `"LATEST"`
state строка	Описывает требуемое состояние. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Если установлено значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; в качестве альтернативы рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
version целое число	Версия функции Lambda. Взаимоисключающий параметр с `alias`. По умолчанию: `0`

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
  amazon.aws.lambda_event:
    state: present
    event_source: stream
    function_name: "{{ function_name }}"
    alias: Dev
    source_params:
      source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
      enabled: true
      batch_size: 100
      starting_position: TRIM_HORIZON
  register: event

# Example that creates a lambda event notification for a DynamoDB stream
- name: DynamoDB stream event mapping
  amazon.aws.lambda_event:
    state: present
    event_source: stream
    function_name: "{{ function_name }}"
    source_params:
      source_arn: arn:aws:dynamodb:us-east-1:123456789012:table/tableName/stream/2016-03-19T19:51:37.457
      enabled: true
      batch_size: 100
      starting_position: LATEST
      function_response_types:
        - ReportBatchItemFailures
  register: event

- name: Show source event
  ansible.builtin.debug:
    var: event.lambda_stream_events

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
events словарь	Словарь, возвращаемый API и описывающий сопоставления событий потока Возвращается: при успешном выполнении
batch_size целое число	Максимальное количество записей в каждом пакете, считываемом Lambda. Возвращается: всегда
bisect_batch_on_function_error логическое значение	Если функция возвращает ошибку, разделить пакет на две части и повторить попытку. Возвращается: только для Kinesis и DynamoDB Streams Пример: `false`
destination_config словарь	Объект конфигурации, задающий назначение события после его обработки Lambda. Возвращается: только для Kinesis, DynamoDB Streams, Amazon MSK и самостоятельно управляемого Kafka
on_failure словарь	Конфигурация назначения для неудачных вызовов. Возвращается: при успешном выполнении
destination строка	ARN ресурса назначения. Возвращается: при успешном выполнении
on_success словарь	Конфигурация назначения для неудачных вызовов. Возвращается: при успешном выполнении
destination строка	ARN ресурса назначения. Возвращается: при успешном выполнении
event_source_arn строка	Имя ресурса Amazon (ARN) источника событий. Возвращается: всегда Пример: `"arn:aws:dynamodb:us-west-2:123456789012:table/yyyy/stream/2024-06-06T07:03:58.956"`
function_arn строка	ARN функции Lambda. Возвращается: всегда Пример: `"arn:aws:lambda:us-west-2:123456789012:function:test-lambda-3a0a29d0dbb5:1"`
function_response_types список / элементы=строка	Список текущих перечислимых типов ответа, применяемых к сопоставлению источника событий. Возвращается: для Kinesis, DynamoDB Streams и Amazon SQS Пример: `["ReportBatchItemFailures"]`
last_modified строка	Дата последнего обновления сопоставления источника событий или изменения его состояния. Возвращается: всегда Пример: `"2024-06-06T12:34:21.990000+05:30"`
last_processing_result строка	Результат последнего вызова вашей функции Lambda. Возвращается: всегда Пример: `"No records processed"`
maximum_batching_window_in_seconds целое число	Максимальное время в секундах, в течение которого Lambda собирает записи перед вызовом функции. Возвращается: всегда Пример: `1`
maximum_record_age_in_seconds целое число	Отбрасывать записи старше указанного срока. По умолчанию значение бесконечно (-1). Возвращается: только для Kinesis и DynamoDB Streams Пример: `-1`
maximum_retry_attempts целое число	Отбрасывать записи после указанного количества повторных попыток. Возвращается: только для Kinesis и DynamoDB Streams Пример: `-1`
parallelization_factor целое число	Количество пакетов, одновременно обрабатываемых из каждого сегмента. Возвращается: только для Kinesis и DynamoDB Streams Пример: `1`
starting_position строка	Позиция в потоке, с которой следует начать чтение. Возвращается: только для Kinesis и DynamoDB Streams Пример: `"LATEST"`
state строка	Состояние сопоставления источника событий. Возвращается: всегда Пример: `"deleting"`
state_transition_reason строка	Указывает, кто последним изменил сопоставление источника событий: пользователь или Lambda. Возвращается: всегда Пример: `"USER_INITIATED"`
tumbling_window_in_seconds целое число	Длительность окна обработки в секундах для источников событий DynamoDB и Kinesis Streams. Возвращается: только для Kinesis и DynamoDB Streams Пример: `1`
uuid строка	Идентификатор сопоставления источника событий. Возвращается: всегда Пример: `"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"`

Авторы

Pierre Jodouin (@pjodouin)
Ryan Brown (@ryansb)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/lambda_event_module.html