amazon.aws.cloudwatchevent_rule модуль — Управление правилами и целевыми объектами CloudWatch Events

Примечание

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

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

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

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

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

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

Обзор

Этот модуль создаёт и управляет правилами и целевыми объектами CloudWatch Events.
Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа 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` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
description string	Описание правила.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
event_pattern json	Строковый шаблон, используемый для сопоставления с входящими событиями, чтобы определить, следует ли запускать правило.
name string / required	Имя правила, которое вы создаете, обновляете или удаляете. Не допускаются пробелы или специальные символы (т.е. должно соответствовать `[\.\-_A-Za-z0-9]+`).
profile aliases: aws_profile string	Именованный профиль AWS для использования при аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды `AWS_PROFILE` также может использоваться. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.
region aliases: aws_region, ec2_region string	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды `AWS_REGION` или `EC2_REGION` также могут использоваться. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
role_arn string	Универсальное имя ресурса (ARN) роли IAM, связанной с правилом.
schedule_expression string	Выражение cron или rate, определяющее расписание, по которому будет запускаться правило. Например, `cron(0 20 * * ? *`), `rate(5 minutes`).
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` также могут использоваться в порядке убывания предпочтения. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сессии 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` также могут использоваться в порядке убывания предпочтения. Параметры security_token и profile являются взаимоисключающими. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state string	Наличие (и включение), отключение или отсутствие правила. Варианты: `"present"` ← (default) `"disabled"` `"absent"`
targets list / elements=dictionary	Список целевых объектов для добавления или обновления для правила. Значение по умолчанию: `[]`
arn string / required	ARN, связанный с целевым объектом.
ecs_parameters dictionary	Содержит определение задачи ECS и количество задач, которые будут использоваться, если целевой объект события — это задача ECS.
task_count integer	Количество задач, которые необходимо создать на основе определения задачи.
task_definition_arn string / required	Полный ARN определения задачи.
id string / required	Уникальный идентификатор назначения цели.
input json	Объект JSON, который переопределит данные события, переданные целевому объекту. Если не указан ни `targets.input`, ни `targets.input_path`, ни `targets.input_transformer`, то все событие передается целевому объекту в формате JSON.
input_path string	Строка JSONPath (например, `$.detail`) которая указывает часть данных события, которые будут переданы целевому объекту. Если не указан ни `targets.input`, ни `targets.input_path`, ни `targets.input_transformer`, то все событие передается целевому объекту в формате JSON.
input_transformer dictionary добавлено в community.aws 4.1.0	Параметры для поддержки предоставления пользовательского ввода целевому объекту на основе определенных данных события.
input_paths_map dictionary	Словарь, который задает преобразование данных события в пользовательские входные параметры.
input_template json	Строка, которая создает шаблоны значений input_paths_map, извлеченных из данных события. Она используется для создания выходных данных, которые вы хотите отправить целевому объекту.
role_arn string	ARN роли IAM, которая будет использоваться для этой цели, когда правило срабатывает.
validate_certs boolean	Когда установлено в `false`, SSL-сертификаты не будут проверяться для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты: `false` `true` ← (default)

Примечания

Примечание

Правило должно содержать как минимум 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 «контроллер», а не из контекста «хост».
AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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 Event. Возвращается: успех
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 Event, назначенные правилу. Возвращается: успех
arn строка	ARN, связанный с целевым объектом. Возвращается: успех Пример: `"arn:aws:lambda:us-east-1:123456789012:function:MyFunction"`
id строка	Уникальный идентификатор назначения цели. Возвращается: успех Пример: `"MyTargetId"`

Авторы

Jim Dalton (@jsdalton)

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

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