Spec-Zone.ru › AWS CLI v2

[ aws . mgn ]

put-template-action

Описание

Установка шаблона пользовательского действия после миграции.

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

Синтаксис

  put-template-action
--action-id <value>
--action-name <value>
[--active | --no-active]
[--category <value>]
[--description <value>]
--document-identifier <value>
[--document-version <value>]
[--external-parameters <value>]
--launch-configuration-template-id <value>
[--must-succeed-for-cutover | --no-must-succeed-for-cutover]
[--operating-system <value>]
--order <value>
[--parameters <value>]
[--timeout-seconds <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]

Параметры

--action-id (строка)

Идентификатор пользовательского действия шаблона после миграции.

--action-name (строка)

Имя пользовательского действия шаблона после миграции.

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

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

--category (строка)

Категория пользовательского действия шаблона после миграции.

Возможные значения:

  • DISASTER_RECOVERY
  • OPERATING_SYSTEM
  • LICENSE_AND_SUBSCRIPTION
  • VALIDATION
  • OBSERVABILITY
  • REFACTORING
  • SECURITY
  • NETWORKING
  • CONFIGURATION
  • BACKUP
  • OTHER

--description (строка)

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

--document-identifier (строка)

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

--document-version (строка)

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

--external-parameters (массив)

Внешние параметры пользовательского действия шаблона после миграции.

ключ -> (строка)

значение -> (структура помеченных объединений)

Внешние параметры документа AWS Systems Manager.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих верхнеуровневых ключей: dynamicPath.

dynamicPath -> (строка)

Динамический путь к внешним параметрам документа AWS Systems Manager.

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

KeyName1=dynamicPath=string,KeyName2=dynamicPath=string

Синтаксис JSON:

{"string": {
      "dynamicPath": "string"
    }
  ...}

--launch-configuration-template-id (строка)

Идентификатор шаблона конфигурации запуска.

--must-succeed-for-cutover | --no-must-succeed-for-cutover (логическое значение)

Пользовательское действие шаблона после миграции должно завершиться успешно для переключения.

--operating-system (строка)

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

--order (целое число)

Порядок пользовательского действия шаблона после миграции.

--parameters (массив)

Параметры пользовательского действия шаблона после миграции.

ключ -> (строка)

значение -> (список)

(структура)

Параметр хранилища параметров AWS Systems Manager.

parameterName -> (строка)

Имя параметра хранилища параметров AWS Systems Manager.

parameterType -> (строка)

Тип параметра хранилища параметров AWS Systems Manager.

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

KeyName1=[{parameterName=string,parameterType=string},{parameterName=string,parameterType=string}],KeyName2=[{parameterName=string,parameterType=string},{parameterName=string,parameterType=string}]

Синтаксис JSON:

{"string": [
      {
        "parameterName": "string",
        "parameterType": "STRING"
      }
      ...
    ]
  ...}

--timeout-seconds (целое число)

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

--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
  • 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.

Вывод

actionID -> (строка)

Идентификатор пользовательского действия шаблона после миграции.

actionName -> (строка)

Имя пользовательского действия шаблона после миграции.

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

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

category -> (строка)

Категория пользовательского действия шаблона после миграции.

description -> (строка)

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

documentIdentifier -> (строка)

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

documentVersion -> (строка)

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

externalParameters -> (массив)

Внешние параметры пользовательского действия шаблона после миграции.

ключ -> (строка)

значение -> (структура помеченных объединений)

Внешние параметры документа AWS Systems Manager.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих верхнеуровневых ключей: dynamicPath.

dynamicPath -> (строка)

Динамический путь к внешним параметрам документа AWS Systems Manager.

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

Пользовательское действие шаблона после миграции должно завершиться успешно для переключения.

operatingSystem -> (строка)

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

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

Порядок пользовательского действия шаблона после миграции.

parameters -> (массив)

Параметры пользовательского действия шаблона после миграции.

ключ -> (строка)

значение -> (список)

(структура)

Параметр хранилища параметров AWS Systems Manager.

parameterName -> (строка)

Имя параметра хранилища параметров AWS Systems Manager.

parameterType -> (строка)

Тип параметра хранилища параметров AWS Systems Manager.

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

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

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

Spec-Zone.ru

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