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 Resource Name (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 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 boolean добавлено в 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), если учетные данные не предоставлены. См. 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. [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.7/modules/cloudwatchevent_rule_module.html