put-rule

Описание

Создаёт или обновляет указанное правило. Правила по умолчанию включены, или в зависимости от значения состояния. Вы можете отключить правило, используя DisableRule.

Одно правило отслеживает события из одного потока событий. События, генерируемые службами Amazon Web Services, попадают в стандартный поток событий вашей учетной записи. События, генерируемые службами партнёров SaaS или приложениями, попадают в соответствующий поток событий партнёра. Если у вас есть пользовательские приложения или службы, вы можете указать, попадают ли их события в стандартный поток событий или в созданный вами пользовательский поток событий. Для получения дополнительной информации см. CreateEventBus.

Если вы обновляете существующее правило, оно заменяется на то, что указано в этом PutRule командном запросе. Если вы опустите аргументы в PutRule, старые значения этих аргументов не сохраняются. Вместо этого они заменяются нулевыми значениями.

При создании или обновлении правила входящие события могут не сразу начать соответствовать новым или обновлённым правилам. Подождите некоторое время, чтобы изменения вступили в силу.

Правило должно содержать как минимум EventPattern или ScheduleExpression. Правила с EventPatterns срабатывают при обнаружении соответствующего события. Правила с ScheduleExpressions срабатывают автоматически в соответствии с заданным расписанием. Правило может иметь как EventPattern, так и ScheduleExpression, в этом случае правило срабатывает как при совпадении с событиями, так и по расписанию.

При первоначальном создании правила вы можете необязательно назначить одно или несколько тегов к правилу. Теги могут помочь вам организовать и категоризировать ваши ресурсы. Вы также можете использовать их для ограничения прав пользователей, предоставив пользователю разрешение на доступ или изменение только правил с определёнными значениями тегов. Чтобы использовать PutRule операцию и назначить теги, у вас должны быть как events:PutRule, так и events:TagResource разрешения.

Если вы обновляете существующее правило, любые теги, которые вы указываете в PutRule операции, игнорируются. Чтобы обновить теги существующего правила, используйте TagResource и UntagResource.

Большинство сервисов в Amazon Web Services обрабатывают : или / как один и тот же символ в именах ресурсов Amazon (ARN). Однако EventBridge использует точное соответствие в шаблонах событий и правилах. Убедитесь, что вы используете правильные символы ARN при создании шаблонов событий, чтобы они соответствовали синтаксису ARN в случае, если вы хотите соответствовать этому.

В EventBridge можно создавать правила, которые приводят к бесконечным циклам, где правило срабатывает многократно. Например, правило может обнаружить изменение ACL на ведре S3 и запустить программное обеспечение для изменения их до желаемого состояния. Если правило не написано тщательно, последующее изменение ACL снова запускает правило, создавая бесконечный цикл.

Чтобы предотвратить это, напишите правила таким образом, чтобы выполняемые действия не запускали то же самое правило повторно. Например, ваше правило может срабатывать только в том случае, если ACL обнаружены в плохом состоянии, а не после любого изменения.

Бесконечный цикл быстро приводит к более высоким, чем ожидалось, расходам. Мы рекомендуем использовать бюджет, который предупреждает вас, когда расходы превышают ваш заданный лимит. Для получения дополнительной информации см. Управление расходами с помощью бюджетов.

Для создания правила, фильтрующего управляющие события от служб Amazon Web Services, см. Получение только для чтения управляющих событий от служб Amazon Web Services в *Руководстве пользователя EventBridge*.

См. также: Документация API AWS

Синтаксис

  put-rule
--name <value>
[--schedule-expression <value>]
[--event-pattern <value>]
[--state <value>]
[--description <value>]
[--role-arn <value>]
[--tags <value>]
[--event-bus-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

--schedule-expression (строка)

--event-pattern (строка)

--state (строка)

--description (строка)

--role-arn (строка)

--tags (список)

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--event-bus-name (строка)

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Передавать произвольные двоичные значения с помощью предоставленного значения JSON невозможно, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON не стабилен между версиями AWS CLI и не гарантирует обратной совместимости сгенерированного JSON-каркаса.

Глобальные параметры

--debug (логическое значение)

Включает отладку регистрации.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

• json
• текст
• таблица
• yaml
• yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла учетных данных.

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

• включено
• выключено
• автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Обрабатываемый пакет сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурируемого cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключение кли-пейджера для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключение автоматического запроса параметров CLI.

Примеры

Для создания правил CloudWatch Events

Этот пример создает правило, которое срабатывает каждый день в 9:00 по UTC. Если вы используете put-targets для добавления функции Lambda в качестве целевого объекта этого правила, вы можете запускать функцию Lambda каждый день в указанное время:

aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)"

Этот пример создает правило, которое срабатывает при изменении состояния любого экземпляра EC2 в регионе:

aws events put-rule --name "EC2InstanceStateChanges" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}"  --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule"

Этот пример создает правило, которое срабатывает, когда любой экземпляр EC2 в регионе останавливается или завершает работу:

aws events put-rule --name "EC2InstanceStateChangeStopOrTerminate" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"],\"detail\":{\"state\":[\"stopped\",\"terminated\"]}}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule"

Вывод

RuleArn -> (строка)