создать-шаблон-эксперимента
Описание
Создаёт шаблон эксперимента.
Шаблон эксперимента включает следующие компоненты:
- Цели : Цель может быть конкретным ресурсом в вашей среде Amazon Web Services или одним или несколькими ресурсами, соответствующими указанным критериям, например, ресурсами, имеющими определённые теги.
- Действия : Действия, которые необходимо выполнить над целью. Вы можете указать несколько действий, продолжительность каждого действия и время начала каждого действия во время эксперимента.
- Условия остановки : Если при выполнении эксперимента срабатывает условие остановки, эксперимент автоматически останавливается. Вы можете определить условие остановки как сигнализацию CloudWatch.
Дополнительную информацию см. в разделе шаблоны экспериментов в Руководстве пользователя Fault Injection Service.
См. также: Документация API AWS
Синтаксис
create-experiment-template
[--client-token <value>]
--description <value>
--stop-conditions <value>
[--targets <value>]
--actions <value>
--role-arn <value>
[--tags <value>]
[--log-configuration <value>]
[--experiment-options <value>]
[--experiment-report-configuration <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]
Параметры
--client-token (строка)
--description (строка)
--stop-conditions (список)
Условия остановки.
(структура)
Определяет условие остановки для шаблона эксперимента.
source -> (строка)
aws:cloudwatch:alarm, если условие остановки определено с помощью сигнализации CloudWatch. Укажите none, если условие остановки отсутствует.value -> (строка)
Краткая форма:
source=string,value=string ...
Синтаксис JSON:
[
{
"source": "string",
"value": "string"
}
...
]
--targets (карта)
Цели эксперимента.
key -> (строка)
value -> (структура)
Определяет цель эксперимента. Вы должны указать как минимум один Amazon Resource Name (ARN) или как минимум один тег ресурса. Вы не можете указать одновременно и ARN, и теги.
Дополнительную информацию см. в разделе Цели в Руководстве пользователя Fault Injection Service.
resourceType -> (строка)
resourceArns -> (список)
Amazon Resource Names (ARN) ресурсов.
(строка)
resourceTags -> (карта)
Теги целевых ресурсов.
key -> (строка)
value -> (строка)
filters -> (список)
Фильтры для идентификации целевых ресурсов с использованием определённых атрибутов.
(структура)
Определяет фильтр, используемый для входных данных целевого ресурса в шаблоне эксперимента.
Дополнительную информацию см. в разделе Фильтры ресурсов в Руководстве пользователя Fault Injection Service.
path -> (строка)
values -> (список)
Значения атрибутов для фильтра.
(строка)
selectionMode -> (строка)
Ограничивает идентифицированные ресурсы до определённого количества ресурсов случайным образом или процента ресурсов. Все идентифицированные ресурсы включены в цель.
- ALL — Выполнить действие над всеми идентифицированными целями. Это значение по умолчанию.
- COUNT(n) — Выполнить действие над указанным количеством целей, выбранных случайным образом из идентифицированных целей. Например, COUNT(1) выбирает одну из целей.
- PERCENT(n) — Выполнить действие над указанным процентом целей, выбранных случайным образом из идентифицированных целей. Например, PERCENT(25) выбирает 25% целей.
parameters -> (карта)
Параметры типа ресурса.
key -> (строка)
value -> (строка)
Синтаксис JSON:
{"string": {
"resourceType": "string",
"resourceArns": ["string", ...],
"resourceTags": {"string": "string"
...},
"filters": [
{
"path": "string",
"values": ["string", ...]
}
...
],
"selectionMode": "string",
"parameters": {"string": "string"
...}
}
...}
--actions (карта)
Действия для эксперимента.
key -> (строка)
value -> (структура)
Определяет действие для шаблона эксперимента.
Дополнительную информацию см. в разделе Действия в Руководстве пользователя Fault Injection Service.
actionId -> (строка)
description -> (строка)
parameters -> (карта)
Параметры действия, если применимо.
key -> (строка)
value -> (строка)
targets -> (карта)
Цели действия.
key -> (строка)
value -> (строка)
startAfter -> (список)
Имя действия, которое должно быть выполнено перед запуском текущего действия. Пропустите этот параметр, чтобы выполнить действие в начале эксперимента.
(строка)
Краткая форма:
KeyName1=actionId=string,description=string,parameters={KeyName1=string,KeyName2=string},targets={KeyName1=string,KeyName2=string},startAfter=string,string,KeyName2=actionId=string,description=string,parameters={KeyName1=string,KeyName2=string},targets={KeyName1=string,KeyName2=string},startAfter=string,string
Синтаксис JSON:
{"string": {
"actionId": "string",
"description": "string",
"parameters": {"string": "string"
...},
"targets": {"string": "string"
...},
"startAfter": ["string", ...]
}
...}
--role-arn (строка)
--tags (карта)
Теги, которые следует применить к шаблону эксперимента.
key -> (строка)
value -> (строка)
Краткая форма:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--log-configuration (структура)
Настройка ведения журнала эксперимента.
cloudWatchLogsConfiguration -> (структура)
Настройка ведения журнала эксперимента в Amazon CloudWatch Logs.
logGroupArn -> (строка)
s3Configuration -> (структура)
Настройка ведения журнала эксперимента в Amazon S3.
bucketName -> (строка)
prefix -> (строка)
logSchemaVersion -> (целое число)
Краткая форма:
cloudWatchLogsConfiguration={logGroupArn=string},s3Configuration={bucketName=string,prefix=string},logSchemaVersion=integer
Синтаксис JSON:
{
"cloudWatchLogsConfiguration": {
"logGroupArn": "string"
},
"s3Configuration": {
"bucketName": "string",
"prefix": "string"
},
"logSchemaVersion": integer
}
--experiment-options (структура)
Параметры эксперимента для шаблона эксперимента.
accountTargeting -> (строка)
emptyTargetResolutionMode -> (строка)
Краткая форма:
accountTargeting=string,emptyTargetResolutionMode=string
Синтаксис JSON:
{
"accountTargeting": "single-account"|"multi-account",
"emptyTargetResolutionMode": "fail"|"skip"
}
--experiment-report-configuration (структура)
Настройка отчёта об эксперименте для шаблона эксперимента.
outputs -> (структура)
Назначение отчёта об эксперименте.
s3Configuration -> (структура)
Назначение в S3 для отчёта об эксперименте.
bucketName -> (строка)
prefix -> (строка)
dataSources -> (структура)
Источники данных для отчёта об эксперименте.
cloudWatchDashboards -> (список)
Панели CloudWatch, которые следует включить в качестве источников данных в отчёте об эксперименте.
(структура)
Определяет панель CloudWatch для отчёта об эксперименте.
dashboardIdentifier -> (строка)
preExperimentDuration -> (строка)
postExperimentDuration -> (строка)
Синтаксис JSON:
{
"outputs": {
"s3Configuration": {
"bucketName": "string",
"prefix": "string"
}
},
"dataSources": {
"cloudWatchDashboards": [
{
"dashboardIdentifier": "string"
}
...
]
},
"preExperimentDuration": "string",
"postExperimentDuration": "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-experiment-template пример создаёт шаблон эксперимента в вашей учётной записи AWS FIS.
aws fis create-experiment-template \
--cli-input-json file://myfile.json
Содержание myfile.json:
{
"description": "experimentTemplate",
"stopConditions": [
{
"source": "aws:cloudwatch:alarm",
"value": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:alarmName"
}
],
"targets": {
"Instances-Target-1": {
"resourceType": "aws:ec2:instance",
"resourceArns": [
"arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
],
"selectionMode": "ALL"
}
},
"actions": {
"reboot": {
"actionId": "aws:ec2:reboot-instances",
"description": "reboot",
"parameters": {},
"targets": {
"Instances": "Instances-Target-1"
}
}
},
"roleArn": "arn:aws:iam::123456789012:role/myRole"
}
Вывод:
{
"experimentTemplate": {
"id": "ABCDE1fgHIJkLmNop",
"description": "experimentTemplate",
"targets": {
"Instances-Target-1": {
"resourceType": "aws:ec2:instance",
"resourceArns": [
"arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
],
"selectionMode": "ALL"
}
},
"actions": {
"reboot": {
"actionId": "aws:ec2:reboot-instances",
"description": "reboot",
"parameters": {},
"targets": {
"Instances": "Instances-Target-1"
}
}
},
"stopConditions": [
{
"source": "aws:cloudwatch:alarm",
"value": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:alarmName"
}
],
"creationTime": 1616434850.659,
"lastUpdateTime": 1616434850.659,
"roleArn": "arn:aws:iam::123456789012:role/myRole",
"tags": {}
}
}
Для получения более подробной информации, см. раздел «Создание шаблона эксперимента» в руководстве пользователя AWS Fault Injection Simulator.
Вывод
experimentTemplate -> (структура)
Информация о шаблоне эксперимента.
id -> (строка)
arn -> (строка)
description -> (строка)
targets -> (карта)
Цели эксперимента.
key -> (строка)
value -> (структура)
Описание цели шаблона эксперимента.
resourceType -> (строка)
resourceArns -> (список)
Amazon Resource Names (ARN) целей.
(строка)
resourceTags -> (карта)
Теги для целевых ресурсов.
key -> (строка)
value -> (строка)
filters -> (список)
Фильтры для идентификации целевых ресурсов с использованием определённых атрибутов.
(структура)
Описание фильтра, используемого для целевых ресурсов в шаблоне эксперимента.
path -> (строка)
values -> (список)
Значения атрибутов для фильтра.
(строка)
selectionMode -> (строка)
parameters -> (карта)
Параметры типа ресурса.
key -> (строка)
value -> (строка)
actions -> (карта)
Действия для эксперимента.
key -> (строка)
value -> (структура)
Описание действия для шаблона эксперимента.
actionId -> (строка)
description -> (строка)
parameters -> (карта)
Параметры действия.
key -> (строка)
value -> (строка)
targets -> (карта)
Цели для действия.
key -> (строка)
value -> (строка)
startAfter -> (список)
Имя действия, которое должно быть завершено перед началом текущего действия.
(строка)
stopConditions -> (список)
Условия остановки эксперимента.
(структура)
Описание условия остановки для шаблона эксперимента.
source -> (строка)
value -> (строка)
creationTime -> (временная метка)
lastUpdateTime -> (временная метка)
roleArn -> (строка)
tags -> (карта)
Теги для шаблона эксперимента.
key -> (строка)
value -> (строка)
logConfiguration -> (структура)
Настройка для протоколирования эксперимента.
cloudWatchLogsConfiguration -> (структура)
Настройка для протоколирования эксперимента в Amazon CloudWatch Logs.
logGroupArn -> (строка)
s3Configuration -> (структура)
Настройка для протоколирования эксперимента в Amazon S3.
bucketName -> (строка)
prefix -> (строка)
logSchemaVersion -> (целое число)
experimentOptions -> (структура)
Параметры эксперимента для шаблона эксперимента.
accountTargeting -> (строка)
emptyTargetResolutionMode -> (строка)
targetAccountConfigurationsCount -> (длинное целое число)
experimentReportConfiguration -> (структура)
Описание конфигурации отчёта об эксперименте для шаблона эксперимента.
outputs -> (структура)
Описание мест назначения отчёта об эксперименте.
s3Configuration -> (структура)
Место назначения S3 для отчёта об эксперименте.
bucketName -> (строка)
prefix -> (строка)
dataSources -> (структура)
Источники данных для отчёта об эксперименте.
cloudWatchDashboards -> (список)
Панели CloudWatch для включения в качестве источников данных в отчёте об эксперименте.
(структура)
Панели CloudWatch для включения в качестве источников данных в отчёте об эксперименте.
dashboardIdentifier -> (строка)
preExperimentDuration -> (строка)
postExperimentDuration -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.