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

Новое в версии 2.2.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

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
description		Описание правила.
ec2_url		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если таковое имеется.
event_pattern		Строковый шаблон (в формате JSON) для сопоставления с входящими событиями, определяющий, должно ли быть выполнено правило.
name обязательно		Имя правила, которое вы создаете, обновляете или удаляете. Не допускаются пробелы или специальные символы (т.е. должно соответствовать `[\.\-_A-Za-z0-9]+`)
profile (добавлен в 1.6)		Использует профиль 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
role_arn		Идентификатор ресурса Amazon (ARN) роли IAM, связанной с правилом.
schedule_expression		Выражение cron или rate, определяющее расписание, по которому будет срабатывать правило. Например, `cron(0 20 * * ? *`), `rate(5 minutes`)
security_token (добавлен в 1.6)		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state	Варианты: present ← disabled absent	Присутствует (и включено), выключено или отсутствует.
targets		Массив словарей целевых объектов для добавления или обновления для правила в формате `{ id: [string], arn: [string], role_arn: [string], input: [valid JSON string], input_path: [valid JSONPath string], ecs_parameters: {task_definition_arn: [string], task_count: [int]}}`. id [обязательно] — уникальный идентификатор назначения целевого объекта. arn (обязательно) — имя ресурса Amazon, связанное с целевым объектом. role_arn (необязательно) — Идентификатор ресурса Amazon (ARN) роли IAM, которая будет использоваться для этого целевого объекта при срабатывании правила. input (необязательно) — объект JSON, который переопределит данные события при передаче целевому объекту. input_path (необязательно) — строка JSONPath (например, `$.detail`) , указывающая часть данных события, которая должна быть передана целевому объекту. Если ни input, ни input_path не указаны, то всё событие передается целевому объекту в формате JSON. task_definition_arn [необязательно] — ecs идентификатор определения задачи. task_count [необязательно] — ecs количество задач.
validate_certs bool (добавлен в 1.5)	Варианты: no yes ←	При установке в «no», сертификаты SSL не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

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

Примеры

- 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

- cloudwatchevent_rule:
    name: MyDisabledCronTask
    schedule_expression: "cron(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"}'

- cloudwatchevent_rule:
    name: MyCronTask
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
rule dict	success	Данные правила CloudWatch Event Пример: {'arn': 'arn:aws:events:us-east-1:123456789012:rule/MyCronTask', 'description': 'Запуск моей запланированной задачи', 'name': 'MyCronTask', 'schedule_expression': 'cron(0 20 * * ? *)', 'state': 'ENABLED'}
targets list	success	Целевой(е) объект(ы) CloudWatch Event, назначенные правилу. Пример: [{ 'arn': 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction', 'id': 'MyTargetId' }]

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/cloudwatchevent_rule_module.html