[ aws . ssm-incidents ]
создать-план-реагирования
Описание
Создаёт план реагирования, который автоматизирует начальную реакцию на инциденты. План реагирования вовлекает контакты, запускает совместную работу в чате и инициирует выполнение руководств при возникновении инцидента.
См. также: Документация AWS API
Синтаксис
create-response-plan
[--actions <value>]
[--chat-channel <value>]
[--client-token <value>]
[--display-name <value>]
[--engagements <value>]
--incident-template <value>
[--integrations <value>]
--name <value>
[--tags <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]
Параметры
--actions (список)
Действия, которые план реагирования запускает в начале инцидента.
(структура помеченного объединения)
Действие, которое запускается в начале инцидента. План реагирования определяет это действие.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня:ssmAutomation.ssmAutomation -> (структура)
Документ автоматизации Systems Manager, который следует запустить в качестве руководства в начале инцидента.
documentName -> (строка)
documentVersion -> (строка)
dynamicParameters -> (отображение)
Пара ключ-значение для разрешения динамических значений параметров при обработке руководства по автоматизации Systems Manager.
key -> (строка)
value -> (структура помеченного объединения)
Динамическое значение параметра SSM.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня:variable.variable -> (строка)
parameters -> (отображение)
Параметры в виде пар ключ-значение для использования при выполнении документа автоматизации.
key -> (строка)
value -> (список)
roleArn -> (строка)
targetAccount -> (строка)
Сокращённый синтаксис:
ssmAutomation={documentName=string,documentVersion=string,dynamicParameters={KeyName1={variable=string},KeyName2={variable=string}},parameters={KeyName1=[string,string],KeyName2=[string,string]},roleArn=string,targetAccount=string} ...
Синтаксис JSON:
[
{
"ssmAutomation": {
"documentName": "string",
"documentVersion": "string",
"dynamicParameters": {"string": {
"variable": "INCIDENT_RECORD_ARN"|"INVOLVED_RESOURCES"
}
...},
"parameters": {"string": ["string", ...]
...},
"roleArn": "string",
"targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"|"IMPACTED_ACCOUNT"
}
}
...
]
--chat-channel (структура помеченного объединения)
Канал чата чатбота, используемый для совместной работы во время инцидента.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня:chatbotSns, empty.chatbotSns -> (список)
Целевые адреса Amazon SNS, которые Chatbot использует для уведомления канала чата об обновлениях инцидента. Вы также можете вносить обновления в инцидент через канал чата, используя темы Amazon SNS.
(строка)
empty -> (структура)
Сокращённый синтаксис:
chatbotSns=string,string,empty={}
Синтаксис JSON:
{
"chatbotSns": ["string", ...],
"empty": {
}
}
--client-token (строка)
--display-name (строка)
--engagements (список)
Идентификатор Amazon Resource Name (ARN) для контактов и планов эскалации, которые план реагирования вовлекает во время инцидента.
(строка)
Синтаксис:
"string" "string" ...
--incident-template (структура)
Детали, используемые для создания инцидента при использовании данного плана реагирования.
dedupeString -> (строка)
Строка, которую Incident Manager использует для предотвращения создания нескольких инцидентов с тем же корнем причины в одном аккаунте.
Строка дедупликации — это термин или фраза, используемая системой для проверки на дублирование инцидентов. Если вы укажете строку дедупликации, Incident Manager будет искать открытые инциденты, содержащие ту же строку в поле dedupeString при создании инцидента. Если дубликат будет обнаружен, Incident Manager дедуплицирует более новый инцидент в существующий.
Примечание
По умолчанию Incident Manager автоматически дедуплицирует несколько инцидентов, созданных одним и тем же Amazon CloudWatch alarm или Amazon EventBridge event. Вам не нужно вводить свою строку дедупликации, чтобы предотвратить дублирование для этих типов ресурсов.impact -> (целое число)
Влияние инцидента на ваших клиентов и приложения.
-
1- Критический -
2- Высокий -
3- Средний -
4- Низкий -
5- Без влияния
incidentTags -> (отображение)
Теги для присвоения шаблону. При вызове действия StartIncident API, Incident Manager присваивает теги, указанные в шаблоне, инциденту.
key -> (строка)
value -> (строка)
notificationTargets -> (список)
Целевые адреса Amazon SNS, которые уведомляются при внесении обновлений в инцидент.
(структура помеченного объединения)
Целевые адреса SNS, которые уведомляются при внесении обновлений в инцидент.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня:snsTopicArn.snsTopicArn -> (строка)
summary -> (строка)
title -> (строка)
Сокращённый синтаксис:
dedupeString=string,impact=integer,incidentTags={KeyName1=string,KeyName2=string},notificationTargets=[{snsTopicArn=string},{snsTopicArn=string}],summary=string,title=string
Синтаксис JSON:
{
"dedupeString": "string",
"impact": integer,
"incidentTags": {"string": "string"
...},
"notificationTargets": [
{
"snsTopicArn": "string"
}
...
],
"summary": "string",
"title": "string"
}
--integrations (список)
Информация о сторонних службах, интегрированных в план реагирования.
(структура помеченного объединения)
Информация о сторонних службах, интегрированных в план реагирования.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня:pagerDutyConfiguration.pagerDutyConfiguration -> (структура)
Информация о службе PagerDuty, где план реагирования создаёт инцидент.
name -> (строка)
pagerDutyIncidentConfiguration -> (структура)
Подробности о службе PagerDuty, связанной с конфигурацией.
serviceId -> (строка)
secretId -> (строка)
Сокращённый синтаксис:
pagerDutyConfiguration={name=string,pagerDutyIncidentConfiguration={serviceId=string},secretId=string} ...
Синтаксис JSON:
[
{
"pagerDutyConfiguration": {
"name": "string",
"pagerDutyIncidentConfiguration": {
"serviceId": "string"
},
"secretId": "string"
}
}
...
]
--name (строка)
--tags (отображение)
Список тегов, которые вы добавляете к плану реагирования.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--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 (boolean)
Включить отладку.
--endpoint-url (string)
Переопределить URL по умолчанию команды на указанный URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить вывод цвета.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)
Отключить пейджер cli для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для создания плана реагирования
Следующий create-response-plan пример создает план реагирования с указанными подробностями.
aws ssm-incidents create-response-plan \
--chat-channel '{"chatbotSns": ["arn:aws:sns:us-east-1:111122223333:Standard_User"]}' \
--display-name "Example response plan" \
--incident-template '{"impact": 5, "title": "example-incident"}' \
--name "example-response" \
--actions '[{"ssmAutomation": {"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT", "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager", "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"}}]' \
--engagements '["arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"]'
Вывод:
{
"arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"
}
Дополнительную информацию см. в разделе Подготовка к инцидентам в Руководстве пользователя Incident Manager.
Вывод
arn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.