Spec-Zone.ru › Ansible 2.10

community.aws.cloudwatchevent_rule – Управление правилами и целевыми объектами CloudWatch Event

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.cloudwatchevent_rule.

Новое в версии 1.0.0: из community.aws

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

Описание

  • Этот модуль создаёт и управляет правилами и целевыми объектами CloudWatch event.

Требования

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

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и будет сделать взаимоисключающим после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла CA Bundle для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: CA Bundle читается со стороны модуля и, возможно, должен быть явно скопирован с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Только ключ 'user_agent' используется для boto-модулей. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и будет взаимоисключающим после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не суммарных) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы выводить в общий список, созданный во время книги задач.
description
строка
Описание правила.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной среды EC2_URL, если таковое имеется.

псевдонимы: aws_endpoint_url, endpoint_url
event_pattern
строка
Строковый шаблон (в формате JSON) для соответствия входящим событиям, чтобы определить, должно ли быть инициировано правило.
name
строка / обязательно
Имя создаваемого, обновляемого или удаляемого правила. Не допускаются пробелы или специальные символы (т.е. должно соответствовать [\.\-_A-Za-z0-9]+).
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременного указания с profile устарела.
aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
AWS регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
role_arn
строка
Amazon Resource Name (ARN) роли IAM, связанной с правилом.
schedule_expression
строка
Выражение cron или rate, определяющее расписание, на котором правило будет срабатывать. Например, cron(0 20 * * ? *), rate(5 minutes).
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и будет взаимоисключающим после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
строка
    Варианты:
  • present ←
  • disabled
  • absent
Наличие (и включение), отключение или отсутствие правила.
targets
список / элементы=словарь
Список целевых объектов для добавления или обновления для правила.
arn
строка / обязательно
ARN, связанный с целевым объектом.
ecs_parameters
словарь
Содержит определение задачи ECS и количество задач, которые будут использоваться, если целевой объект события — задача ECS.
task_count
целое число
Количество задач, созданных на основе task_definition.
task_definition_arn
строка
Полный ARN определения задачи.
id
строка / обязательно
Уникальный идентификатор назначения целевого объекта.
input
строка
Объект JSON, который переопределит данные события при передаче целевому объекту.
Если не указаны ни input, ни input_path, то всё событие передаётся целевому объекту в формате JSON.
input_path
строка
Строка JSONPath (например, $.detail) которая определяет часть данных события, передаваемую целевому объекту.
Если не указаны ни input, ни input_path, то всё событие передаётся целевому объекту в формате JSON.
role_arn
строка
ARN роли IAM, которая будет использоваться для этого целевого объекта, когда правило будет срабатывать.
validate_certs
булево
    Варианты:
  • нет
  • да ←
При установке в «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

  • Правило должно содержать как минимум event_pattern или schedule_expression. Правило может содержать как event_pattern, так и schedule_expression, в этом случае правило будет срабатывать на соответствиях событий, а также по расписанию.
  • При указании целевых объектов input и input_path являются взаимно исключающими и необязательными параметрами.
  • Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета: AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION могут использоваться для указания AWS региона, когда это требуется, но это также можно настроить в конфигурационном файле boto

Примеры

- community.aws.cloudwatchevent_rule:
    name: MyCronTask
    schedule_expression: "cron(0 20 * * ? *)"
    description: Run my scheduled task
    targets:
      - id: MyTargetId
        arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction

- community.aws.cloudwatchevent_rule:
    name: MyDisabledCronTask
    schedule_expression: "rate(5 minutes)"
    description: Run my disabled scheduled task
    state: disabled
    targets:
      - id: MyOtherTargetId
        arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction
        input: '{"foo": "bar"}'

- community.aws.cloudwatchevent_rule:
    name: MyCronTask
    state: absent

Значения возврата

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

Ключ Возвращено Описание
rule
словарь
успех
Данные правила CloudWatch Event.

Пример:
{'arn': 'arn:aws:events:us-east-1:123456789012:rule/MyCronTask', 'description': 'Запустить мое запланированное задание', 'name': 'MyCronTask', 'schedule_expression': 'cron(0 20 * * ? *)', 'state': 'ENABLED'}
targets
список / элементы=строка
успех
Цель(и) CloudWatch Event, назначенная(ые) правилу.

Пример:
[{ 'arn': 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction', 'id': 'MyTargetId' }]


Авторы

  • Jim Dalton (@jsdalton) <jim.dalton@gmail.com>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/cloudwatchevent_rule_module.html

Spec-Zone.ru

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