Модуль amazon.aws.lambda_event — Создаёт, обновляет или удаляет сопоставления событий функций AWS Lambda
Примечание
Этот модуль является частью коллекции amazon.aws (версии 8.2.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
alias string | Имя псевдонима функции. Взаимоисключающе с |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
event_source string | Источник события, которое запускает функцию lambda. Для событий DynamoDB и Kinesis выберите Для очередей SQS выберите Варианты:
|
lambda_function_arn aliases: function_name, function_arn string / required | Имя или ARN функции lambda. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка | Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 01.12.2024. Поддержка переменных среды |
source_params словарь / обязательно | Дополнительные параметры, необходимые для источника событий. |
|
batch_size целое число |
Максимальное количество записей, которое AWS Lambda извлечет из источника событий при вызове функции. Amazon Kinesis - Значение по умолчанию Amazon DynamoDB Streams - Значение по умолчанию Amazon Simple Queue Service - Значение по умолчанию Amazon Managed Streaming for Apache Kafka - Значение по умолчанию Самостоятельно управляемый Apache Kafka - Значение по умолчанию Amazon MQ (ActiveMQ и RabbitMQ) - Значение по умолчанию DocumentDB - Значение по умолчанию |
|
enabled булево |
Указывает, должен ли AWS Lambda начать опрос или чтение из источника событий. Варианты:
|
|
function_response_types список / элементы=строка добавлено в amazon.aws 5.5.0 |
(Потоки и Amazon SQS) Список текущих типов ответов, применяемых к картографированию источника событий. Варианты:
|
|
maximum_batching_window_in_seconds целое число добавлено в amazon.aws 8.0.0 |
Максимальное время (в секундах), которое Lambda тратит на сбор записей перед вызовом функции. Вы можете настроить Для потоков и Amazon SQS источников событий, когда
|
|
source_arn строка / обязательно |
Идентификатор ресурса Amazon (ARN) очереди SQS, потока Kinesis или потока DynamoDB, являющегося источником событий. |
|
starting_position строка |
Позиция в потоке, с которой AWS Lambda должно начать чтение. Необходимо, когда Варианты:
|
state строка | Описывает желаемое состояние. Варианты:
|
validate_certs булево | При установке в Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты:
|
version целое число |
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост» а не контекста «контроллер». Следовательно, файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер» а не «хост» контекста.
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из его конфигурационных файлов в контексте 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 dictionary | Словарь, возвращаемый API, описывающий сопоставления событий потока Возвращается: успех |
|
batch_size integer |
Максимальное количество записей в каждой пачке, извлекаемых Lambda. Возвращается: всегда |
|
bisect_batch_on_function_error boolean |
Если функция возвращает ошибку, разделить пакет на две части и повторить попытку. Возвращается: только для Kinesis и DynamoDB Streams Пример: |
|
destination_config dictionary |
Объект конфигурации, указывающий назначение события после обработки Lambda. Возвращается: Только для Kinesis, DynamoDB Streams, Amazon MSK и самообслуживаемых Kafka |
|
on_failure dictionary |
Конфигурация назначения для неудачных вызовов. Возвращается: успех |
|
destination string |
ARN ресурса назначения. Возвращается: успех |
|
on_success dictionary |
Конфигурация назначения для неудачных вызовов. Возвращается: успех |
|
destination string |
ARN ресурса назначения. Возвращается: успех |
|
event_source_arn string |
Универсальное имя ресурса (ARN) источника события. Возвращается: всегда Пример: |
|
function_arn string |
ARN функции Lambda. Возвращается: всегда Пример: |
|
function_response_types list / elements=string |
Список текущих перечислений типов ответов, примененных к сопоставлению источника событий. Возвращается: Для Kinesis, DynamoDB Streams и Amazon SQS Пример: |
|
last_modified string |
Дата последнего обновления сопоставления источника событий или изменения его состояния. Возвращается: всегда Пример: |
|
last_processing_result string |
Результат последнего вызова вашей функции Lambda. Возвращается: всегда Пример: |
|
maximum_batching_window_in_seconds integer |
Максимальное время в секундах, которое Lambda тратит на сбор записей перед вызовом функции. Возвращается: всегда Пример: |
|
maximum_record_age_in_seconds integer |
Отбрасывать записи старше указанного возраста. Значение по умолчанию бесконечно (-1). Возвращается: Только для Kinesis и DynamoDB Streams Пример: |
|
maximum_retry_attempts integer |
Отбрасывать записи после указанного количества повторных попыток. Возвращается: Только для Kinesis и DynamoDB Streams Пример: |
|
parallelization_factor integer |
Количество пакетов для параллельной обработки из каждого фрагмента. Возвращается: Только для Kinesis и DynamoDB Streams Пример: |
|
starting_position string |
Позиция в потоке, с которой следует начать чтение. Возвращается: Только для Kinesis и DynamoDB Streams Пример: |
|
state string |
Состояние источника событий. Возвращается: всегда Пример: |
|
state_transition_reason string |
Указывает, пользователь или Lambda произвели последнее изменение в источнике событий. Возвращается: всегда Пример: |
|
tumbling_window_in_seconds integer |
Продолжительность окна обработки в секундах для источников событий DynamoDB и Kinesis Streams. Возвращается: Только для Kinesis и DynamoDB Streams Пример: |
|
uuid string |
Идентификатор источника событий. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/lambda_event_module.html
