Модуль amazon.aws.cloudwatchevent_rule — управление правилами и целями событий CloudWatch

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.cloudwatchevent_rule.

Добавлено в amazon.aws 5.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль создает правила событий CloudWatch и управляет ими, а также управляет целями.
Этот модуль впервые добавлен в community.aws в выпуске 1.0.0.

Требования

Следующие требования необходимы на хосте, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов CA, который используется для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и записывать набор в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action`, чтобы вывести полный список вызовов, выполненных за время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Описание правила.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
event_pattern json	Строковый шаблон для сопоставления с поступающими событиями, определяющий, следует ли запускать правило.
name строка / обязательный	Имя создаваемого, обновляемого или удаляемого правила. Пробелы и специальные символы не допускаются (то есть имя должно соответствовать `[\.\-_A-Za-z0-9]+`).
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
role_arn строка	Имя ресурса Amazon (ARN) роли IAM, связанной с правилом.
schedule_expression строка	Выражение cron или rate, задающее расписание срабатывания правила. Например, `cron(0 20 * * ? *`), `rate(5 minutes`).
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	Состояние правила: присутствует (и включено), отключено или отсутствует. Варианты: `"present"` ← (по умолчанию) `"disabled"` `"absent"`
targets список / элементы=словарь	Список целей, добавляемых к правилу или обновляемых для него. По умолчанию: `[]`
arn строка / обязательный	ARN, связанный с целью.
ecs_parameters словарь	Содержит определение задачи ECS и количество задач, которые будут использоваться, если цель события — задача ECS.
task_count целое число	Количество задач, создаваемых на основе определения задачи.
task_definition_arn строка / обязательный	Полный ARN определения задачи.
id строка / обязательный	Уникальный идентификатор назначения цели.
input json	Объект JSON, переопределяющий данные события, передаваемые цели. Если не указаны `targets.input`, `targets.input_path` и `targets.input_transformer`, цели передается все событие в формате JSON.
input_path строка	Строка JSONPath (например, `$.detail`), задающая часть данных события, передаваемую цели. Если не указаны `targets.input`, `targets.input_path` и `targets.input_transformer`, цели передается все событие в формате JSON.
input_transformer словарь добавлено в community.aws 4.1.0	Настройки для передачи цели пользовательских входных данных на основе определенных данных события.
input_paths_map словарь	Словарь, задающий преобразование данных события в пользовательские входные параметры.
input_template json	Строка-шаблон для значений, извлеченных из данных события с помощью input_paths_map. Она используется для формирования выходных данных, отправляемых цели.
role_arn строка	ARN роли IAM, используемой для этой цели при срабатывании правила.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Правило должно содержать как минимум event_pattern или schedule_expression. Правило может содержать и event_pattern, и schedule_expression; в этом случае оно будет срабатывать как при совпадении событий, так и по расписанию.
При указании целей параметры targets.input, targets.input_path, targets.input_transformer.input_paths_map и targets.input_transformer.input_template являются взаимоисключающими и необязательными.
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для подключаемых модулей поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «контроллер», а не «хост».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- amazon.aws.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

- amazon.aws.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"}'

- amazon.aws.cloudwatchevent_rule:
    name: MyInstanceLaunchEvent
    description: "Rule for EC2 instance launch"
    state: present
    event_pattern: '{"source":["aws.ec2"],"detail-type":["EC2 Instance State-change Notification"],"detail":{"state":["pending"]}}'
    targets:
      - id: MyTargetSnsTopic
        arn: arn:aws:sns:us-east-1:123456789012:MySNSTopic
        input_transformer:
          input_paths_map:
            instance: "$.detail.instance-id"
            state: "$.detail.state"
          input_template: "<instance> is in state <state>"

- amazon.aws.cloudwatchevent_rule:
    name: MyCronTask
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
rule словарь	Данные правила событий CloudWatch. Возвращается: при успешном выполнении
arn строка	ARN, связанный с правилом. Возвращается: при успешном выполнении Пример: `"arn:aws:events:us-east-1:123456789012:rule/MyCronTask"`
description строка	Описание правила. Возвращается: при успешном выполнении Пример: `"Run my scheduled task"`
name строка	Имя создаваемого, обновляемого или удаляемого правила. Возвращается: при успешном выполнении Пример: `"MyCronTask"`
schedule_expression строка	Выражение cron или rate, задающее расписание срабатывания правила. Возвращается: при успешном выполнении Пример: `"cron(0 20 * * ? *)"`
state строка	Состояние правила: присутствует (и включено), отключено или отсутствует. Возвращается: при успешном выполнении Пример: `"enabled"`
targets список / элементы=словарь	Цели событий CloudWatch, назначенные правилу. Возвращается: при успешном выполнении
arn строка	ARN, связанный с целью. Возвращается: при успешном выполнении Пример: `"arn:aws:lambda:us-east-1:123456789012:function:MyFunction"`
id строка	Уникальный идентификатор назначения цели. Возвращается: при успешном выполнении Пример: `"MyTargetId"`

Авторы

Jim Dalton (@jsdalton)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/cloudwatchevent_rule_module.html