Spec-Zone.ru › AWS CLI v2

[ aws . fis ]

обновить-шаблон-эксперимента

Описание

Обновляет указанный шаблон эксперимента.

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

Синтаксис

  update-experiment-template
--id <value>
[--description <value>]
[--stop-conditions <value>]
[--targets <value>]
[--actions <value>]
[--role-arn <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]

Параметры

--id (строка)

Идентификатор шаблона эксперимента.

--description (строка)

Описание шаблона.

--stop-conditions (список)

Условия остановки эксперимента.

(структура)

Определяет условие остановки эксперимента. Вы можете определить условие остановки как сигнал CloudWatch.

source -> (строка)

Источник условия остановки. Укажите aws:cloudwatch:alarm, если условие остановки определяется сигналом CloudWatch. Укажите none, если условие остановки отсутствует.

value -> (строка)

Amazon Resource Name (ARN) сигнала CloudWatch.

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

source=string,value=string ...

Синтаксис JSON:

[
  {
    "source": "string",
    "value": "string"
  }
  ...
]

--targets (массив)

Цели эксперимента.

key -> (строка)

value -> (структура)

Определяет цель эксперимента. Вы должны указать как минимум один Amazon Resource Name (ARN) или как минимум один тег ресурса. Вы не можете указать оба.

resourceType -> (строка)

Тип ресурса. Тип ресурса должен поддерживаться для указанного действия.

resourceArns -> (список)

Amazon Resource Names (ARN) целей.

(строка)

resourceTags -> (массив)

Теги целевых ресурсов.

key -> (строка)

value -> (строка)

filters -> (список)

Фильтры для определения целевых ресурсов по определённым атрибутам.

(структура)

Определяет фильтр, используемый для входных данных целевого ресурса в шаблоне эксперимента.

Для получения дополнительной информации см. Фильтры ресурсов в Руководстве пользователя Fault Injection Service.

path -> (строка)

Путь к атрибуту для фильтра.

values -> (список)

Значения атрибутов для фильтра.

(строка)

selectionMode -> (строка)

Ограничивает идентифицированные ресурсы до определённого количества или процента.

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 -> (структура)

Определяет действие для шаблона эксперимента.

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 (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей службе FIS разрешение на выполнение сервисных действий от вашего имени.

--log-configuration (структура)

Настройка ведения журнала эксперимента.

cloudWatchLogsConfiguration -> (структура)

Настройка ведения журнала эксперимента в Amazon CloudWatch Logs.

logGroupArn -> (строка)

Amazon Resource Name (ARN) целевой группы журналов Amazon CloudWatch Logs.

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 (структура)

Параметры эксперимента для шаблона эксперимента.

emptyTargetResolutionMode -> (строка)

Режим разрешения пустых целевых ресурсов шаблона эксперимента.

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

emptyTargetResolutionMode=string

Синтаксис JSON:

{
  "emptyTargetResolutionMode": "fail"|"skip"
}

--experiment-report-configuration (структура)

Настройка отчёта об эксперименте для шаблона эксперимента.

outputs -> (структура)

Описание мест назначения отчёта об эксперименте.

s3Configuration -> (структура)

Место назначения отчёта об эксперименте в S3.

bucketName -> (строка)

Имя хранилища S3, где будет храниться отчёт об эксперименте.

prefix -> (строка)

Префикс хранилища S3, где будет храниться отчёт об эксперименте.

dataSources -> (структура)

Источники данных для отчёта об эксперименте.

cloudWatchDashboards -> (список)

Панели CloudWatch, которые следует включить в качестве источников данных в отчёте об эксперименте.

(структура)

Определяет панель CloudWatch для отчёта об эксперименте.

dashboardIdentifier -> (строка)

Amazon Resource Name (ARN) панели CloudWatch, которую следует включить в отчёт об эксперименте.

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. Если предоставлено значение NULL или значение 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
  • text
  • таблица
  • 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 для вывода.

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

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

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

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для обновления шаблона эксперимента

Следующий update-experiment-template пример обновляет описание указанного шаблона эксперимента.

aws fis update-experiment-template \
    --id ABCDE1fgHIJkLmNop \
    ---description myExperimentTemplate

Вывод:

{
    "experimentTemplate": {
        "id": "ABCDE1fgHIJkLmNop",
        "description": "myExperimentTemplate",
        "targets": {
            "Instances-Target-1": {
                "resourceType": "aws:ec2:instance",
                "resourceArns": [
                    "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
                ],
                "selectionMode": "ALL"
            }
        },
        "actions": {
            "testaction": {
                "actionId": "aws:ec2:stop-instances",
                "parameters": {},
                "targets": {
                    "Instances": "Instances-Target-1"
                }
            }
        },
        "stopConditions": [
            {
                "source": "none"
            }
        ],
        "creationTime": 1616017191.124,
        "lastUpdateTime": 1616017859.607,
        "roleArn": "arn:aws:iam::123456789012:role/FISRole",
        "tags": {
            "key": "value"
        }
    }
}

Для получения дополнительной информации см. раздел «Обновление шаблона эксперимента» в руководстве пользователя AWS Fault Injection Simulator.

Вывод

experimentTemplate -> (структура)

Информация о шаблоне эксперимента.

id -> (строка)

Идентификатор шаблона эксперимента.

arn -> (строка)

Amazon Resource Name (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 -> (строка)

Amazon Resource Name (ARN) сигнализации CloudWatch, если применимо.

creationTime -> (временная метка)

Время создания шаблона эксперимента.

lastUpdateTime -> (временная метка)

Время последнего обновления шаблона эксперимента.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM.

tags -> (карта)

Теги для шаблона эксперимента.

key -> (строка)

value -> (строка)

logConfiguration -> (структура)

Настройка ведения журнала эксперимента.

cloudWatchLogsConfiguration -> (структура)

Настройка ведения журнала эксперимента в Amazon CloudWatch Logs.

logGroupArn -> (строка)

Amazon Resource Name (ARN) целевой группы журнала Amazon CloudWatch Logs.

s3Configuration -> (структура)

Настройка ведения журнала эксперимента в Amazon S3.

bucketName -> (строка)

Имя целевого ведра.

prefix -> (строка)

Префикс ведра.

logSchemaVersion -> (целое число)

Версия схемы.

experimentOptions -> (структура)

Параметры эксперимента для шаблона эксперимента.

accountTargeting -> (строка)

Настройка для целевого аккаунта для шаблона эксперимента.

emptyTargetResolutionMode -> (строка)

Режим разрешения пустой цели для шаблона эксперимента.

targetAccountConfigurationsCount -> (длинное целое число)

Количество конфигураций целевых аккаунтов для шаблона эксперимента.

experimentReportConfiguration -> (структура)

Описание конфигурации отчета об эксперименте для шаблона эксперимента.

outputs -> (структура)

Описание мест назначения отчета об эксперименте.

s3Configuration -> (структура)

Место назначения S3 для отчета об эксперименте.

bucketName -> (строка)

Имя ведра S3, в котором будет храниться отчет об эксперименте.

prefix -> (строка)

Префикс ведра S3, в котором будет храниться отчет об эксперименте.

dataSources -> (структура)

Источники данных для отчета об эксперименте.

cloudWatchDashboards -> (список)

Панели CloudWatch, которые следует включить в качестве источников данных в отчете об эксперименте.

(структура)

Панели CloudWatch, которые следует включить в качестве источников данных в отчете об эксперименте.

dashboardIdentifier -> (строка)

Amazon Resource Name (ARN) панели CloudWatch, которую нужно включить в отчет об эксперименте.

preExperimentDuration -> (строка)

Продолжительность до начала эксперимента для включения источников данных в отчет.

postExperimentDuration -> (строка)

Продолжительность после завершения эксперимента для включения источников данных в отчет.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API