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

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

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	Значение по умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
description		Описание правила
ec2_url	Значение по умолчанию: None	URL для подключения к EC2 или облаку Eucalyptus (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если таковая есть.
event_pattern		Строковый шаблон (в формате JSON), используемый для сопоставления входящих событий, чтобы определить, должно ли быть выполнено правило
name обязательно		Имя правила, которое вы создаете, обновляете или удаляете. Пробелы и специальные символы запрещены (т. е. должно соответствовать `[\.\-_A-Za-z0-9]+`)
profile (добавлено в 1.6)	Значение по умолчанию: None	Использует профиль 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 Resource Name (ARN) роли IAM, связанной с правилом
schedule_expression		Выражение cron или rate, определяющее расписание, по которому правило будет срабатывать. Например, `cron(0 20 * * ? *`), `rate(5 minutes`)
security_token (добавлено в 1.6)	Значение по умолчанию: None	Токен безопасности 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 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)	Варианты: 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	успех	Данные правила CloudWatch Event Пример: {'name': 'MyCronTask', 'state': 'ENABLED', 'description': 'Run my scheduled task', 'arn': 'arn:aws:events:us-east-1:123456789012:rule/MyCronTask', 'schedule_expression': 'cron(0 20 * * ? *)'}
targets list	успех	Целевые объекты 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.5/modules/cloudwatchevent_rule_module.html