s3_bucket_notification – Создаёт, обновляет или удаляет уведомления о событиях в ведре S3 для lambda

Новая в версии 2.9.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Этот модуль позволяет управлять соответствиями событий ведра AWS Lambda-функции через фреймворк Ansible. Используйте модуль lambda для управления самой Lambda-функцией, lambda_alias для управления псевдонимами функций и lambda_policy для изменения разрешений Lambda.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
bucket_name строка / обязательно		Имя ведра S3
debug_botocore_endpoint_logs логический тип добавлено в 2.8	Варианты: нет ← да	Использовать регистрирующую функцию botocore.endpoint для обработки уникальных (а не общих) API-вызовов "resource:action", выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в полный список, созданный во время выполнения сценария.
ec2_url строка		URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL.
event_name строка / обязательно		уникальное имя для уведомления о событии в ведре
events список / обязательно	Варианты: s3:ObjectCreated:* s3:ObjectCreated:Put s3:ObjectCreated:Post s3:ObjectCreated:Copy s3:ObjectCreated:CompleteMultipartUpload s3:ObjectRemoved:* s3:ObjectRemoved:Delete s3:ObjectRemoved:DeleteMarkerCreated s3:ObjectRestore:Post s3:ObjectRestore:Completed s3:ReducedRedundancyLostObject	События, которые должны вызывать уведомления. Вы можете выбрать несколько событий для отправки в один и тот же пункт назначения, настроить разные события для отправки в разные пункты назначения и настроить префикс или суффикс для события. Однако для каждого ведра отдельные события не могут иметь несколько конфигураций с перекрывающимися префиксами или суффиксами, которые могут соответствовать одному и тому же ключу объекта.
lambda_alias строка		Имя псевдонима Lambda-функции. Взаимоисключающий с `lambda_version`.
lambda_function_arn строка		ARN Lambda-функции. Псевдонимы: function_arn
lambda_version целое число		Версия Lambda-функции. Взаимоисключающий с `lambda_alias`.
prefix строка		Необязательный префикс для ограничения уведомлений объектами с ключами, начинающимися с совпадающих символов.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
region строка		AWS-регион. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token строка		AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state строка / обязательно	Варианты: present ← absent	Описывает желаемое состояние.
suffix строка		Необязательный суффикс для ограничения уведомлений объектами с ключами, заканчивающимися совпадающими символами.
validate_certs логический тип	Варианты: нет да ←	Если установлено "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены.

Примечания

Примечание

Этот модуль сильно зависит от lambda_policy, так как вам нужно разрешить lambda:InvokeFunction разрешение для вашей lambda-функции.
Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION.
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION могут использоваться для указания AWS-региона, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

---
# Example that creates a lambda event notification for a bucket
- hosts: localhost
  gather_facts: no
  tasks:
  - name: Process jpg image
    s3_bucket_notification:
      state: present
      event_name: on_file_add_or_remove
      bucket_name: test-bucket
      function_name: arn:aws:lambda:us-east-2:526810320200:function:test-lambda
      events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
      prefix: images/
      suffix: .jpg

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

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

Ключ	Возвращаемое значение	Описание
notification_configuration список	успех	список текущих применённых уведомлений

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

XLAB d.o.o. (@xlab-si)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/s3_bucket_notification_module.html