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

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

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

Обзор

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

Требования

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

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
debug_botocore_endpoint_logs логический тип добавлено в 2.8	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", выполненных во время задачи, выводимых в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время выполнения playbook. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description -		Описание правила
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она задана.
event_pattern -		Строковый шаблон (в формате JSON), используемый для сопоставления входящих событий, чтобы определить, следует ли запускать правило
name - / обязательно		Имя создаваемого, обновляемого или удаляемого правила. Не допускаются пробелы или специальные символы (т.е. должно соответствовать `[\.\-_A-Za-z0-9]+`)
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
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. псевдонимы: access_token
state -	Варианты: присутствует ← отключено отсутствует	Присутствует (и включено), отключено или отсутствует правило
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 логический тип	Варианты: нет да ←	Если установлено значение "нет", сертификаты 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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: "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"}'

- 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': 'ВКЛЮЧЕНО'}
targets список	успех	Целевые объекты CloudWatch Event, назначенные правилу Пример: [{ 'arn': 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction', 'id': 'MyTargetId' }]

Статус

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

Авторы

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