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

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

Обзор

Этот модуль создаёт и управляет правилами и целевыми объектами 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 (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, связанный с целевым объектом. role_arn (необязательно) — идентификатор ресурса Amazon роли 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': 'ENABLED'}
targets список	успех	Целевой(ые) объект(ы) CloudWatch Event, назначенные правилу Пример: [{ 'arn': 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction', 'id': 'MyTargetId' }]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/cloudwatchevent_rule_module.html