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.
role_arn	нет			Amazon Resource Name (ARN) роли IAM, связанной с правилом
schedule_expression	нет			Выражение cron или rate, определяющее расписание, по которому правило будет срабатывать. Например, `cron(0 20 * * ? *`), `rate(5 minutes`)
security_token (добавлено в 1.6)	нет			AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state	нет	present	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 Resource Name, связанный с целевым объектом. role_arn (необязательно) — Amazon Resource Name роли IAM, которая будет использоваться для этого целевого объекта при срабатывании правила. input (необязательно) — объект JSON, который переопределит данные события при передаче целевому объекту. input_path (необязательно) — строка JSONPath (например, `$.detail`) , указывающая часть данных события, передаваемую целевому объекту. Если ни input, ни input_path не указаны, то всё событие передаётся целевому объекту в формате JSON. task_definition_arn [необязательно] — arn определения задачи ecs. task_count [необязательно] — количество задач ecs.
validate_certs (добавлено в 1.5)	нет	да	да нет	При значении "нет", сертификаты SSL не будут проверены для boto версий >= 2.6.0.

Примеры

- 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	Данные правила 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' }]

Примечания

Примечание

Правило должно содержать как минимум 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

Статус

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

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

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