Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

обновить-зарезервированный-продукт

Описание

Запрашивает обновления конфигурации указанного зарезервированного продукта.

Если с объектом связаны теги, их нельзя обновить или добавить. В зависимости от запрошенных обновлений данная операция может обновить продукт без прерываний, с некоторыми прерываниями или полностью заменить зарезервированный продукт.

Статус этого запроса можно проверить с помощью DescribeRecord.

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

Синтаксис

  update-provisioned-product
[--accept-language <value>]
[--provisioned-product-name <value>]
[--provisioned-product-id <value>]
[--product-id <value>]
[--product-name <value>]
[--provisioning-artifact-id <value>]
[--provisioning-artifact-name <value>]
[--path-id <value>]
[--path-name <value>]
[--provisioning-parameters <value>]
[--provisioning-preferences <value>]
[--tags <value>]
[--update-token <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]

Параметры

--accept-language (строка)

Код языка.

  • jp - Японский
  • zh - Китайский

--provisioned-product-name (строка)

Имя зарезервированного продукта. Вы не можете указать и ProvisionedProductName, и ProvisionedProductId.

--provisioned-product-id (строка)

Идентификатор зарезервированного продукта. Вы должны указать имя или идентификатор, но не оба.

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

Идентификатор продукта. Вы должны указать имя или идентификатор, но не оба.

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

Имя продукта. Вы должны указать имя или идентификатор, но не оба.

--provisioning-artifact-id (строка)

Идентификатор артефакта подготовки.

--provisioning-artifact-name (строка)

Имя артефакта подготовки. Вы должны указать имя или идентификатор, но не оба.

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

Идентификатор пути. Это значение необязательно, если у продукта есть стандартный путь, и необходимо, если у продукта более одного пути. Вы должны указать имя или идентификатор, но не оба.

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

Имя пути. Вы должны указать имя или идентификатор, но не оба.

--provisioning-parameters (список)

Новые параметры.

(структура)

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

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

Ключ параметра.

Значение -> (строка)

Значение параметра.

UsePreviousValue -> (булево)

Если установлено в true, Value игнорируется, и предыдущее значение параметра сохраняется.

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

Key=string,Value=string,UsePreviousValue=boolean ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "UsePreviousValue": true|false
  }
  ...
]

--provisioning-preferences (структура)

Объект, содержащий информацию о настройках подготовки для набора стеков.

StackSetAccounts -> (список)

Один или несколько аккаунтов Amazon Web Services, которые будут иметь доступ к зарезервированному продукту.

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Указанные аккаунты Amazon Web Services должны находиться в списке аккаунтов в ограничении STACKSET. Чтобы получить список аккаунтов в ограничении STACKSET, используйте операцию DescribeProvisioningParameters.

Если значения не указаны, по умолчанию используется все аккаунты из ограничения STACKSET.

(строка)

StackSetRegions -> (список)

Один или несколько регионов Amazon Web Services, где зарезервированный продукт будет доступен.

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Указанные регионы должны находиться в списке регионов из ограничения STACKSET. Чтобы получить список регионов в ограничении STACKSET, используйте операцию DescribeProvisioningParameters.

Если значения не указаны, по умолчанию используются все регионы из ограничения STACKSET.

(строка)

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

Количество аккаунтов в каждом регионе, для которых данная операция может завершиться неудачно, прежде чем Service Catalog остановит операцию в этом регионе. Если операция остановлена в регионе, Service Catalog не пытается выполнить операцию в последующих регионах.

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Условие: Вы должны указать либо StackSetFailureToleranceCount, либо StackSetFailureTolerancePercentage, но не оба.

Значение по умолчанию — 0, если значение не указано.

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

Процент аккаунтов в каждом регионе, для которых операция стека может завершиться неудачно, прежде чем Service Catalog остановит операцию в этом регионе. Если операция остановлена в регионе, Service Catalog не пытается выполнить операцию в последующих регионах.

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

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Условие: Вы должны указать либо StackSetFailureToleranceCount, либо StackSetFailureTolerancePercentage, но не оба.

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

Максимальное количество аккаунтов, в которых данная операция может выполняться одновременно. Это зависит от значения StackSetFailureToleranceCount. StackSetMaxConcurrentCount не может быть более чем на единицу больше, чем StackSetFailureToleranceCount.

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

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Условие: Вы должны указать либо StackSetMaxConcurrentCount, либо StackSetMaxConcurrentPercentage, но не оба.

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

Максимальный процент аккаунтов, в которых данная операция может выполняться одновременно.

При расчёте количества аккаунтов на основе указанного процента Service Catalog округляет вниз до ближайшего целого числа. Это верно за исключением случаев, когда округление вниз приводит к нулю. В этом случае Service Catalog устанавливает значение как 1.

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

Применимо только к типу зарезервированного продукта CFN_STACKSET.

Условие: Вы должны указать либо StackSetMaxConcurrentCount, либо StackSetMaxConcurrentPercentage, но не оба.

StackSetOperationType -> (строка)

Определяет действие, которое Service Catalog выполняет для набора стеков или экземпляра стека, представленного зарезервированным продуктом. По умолчанию значение — UPDATE, если ничего не указано.

Применимо только к типу зарезервированного продукта CFN_STACKSET.

CREATE

Создаёт новый экземпляр стека в наборе стеков, представленном зарезервированным продуктом. В этом случае создаются только новые экземпляры стеков на основе аккаунтов и регионов; если переданы новые ProductId или ProvisioningArtifactID, они будут проигнорированы.

UPDATE

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

DELETE

Удаляет экземпляр стека в наборе стеков, представленном зарезервированным продуктом.

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

StackSetAccounts=string,string,StackSetRegions=string,string,StackSetFailureToleranceCount=integer,StackSetFailureTolerancePercentage=integer,StackSetMaxConcurrencyCount=integer,StackSetMaxConcurrencyPercentage=integer,StackSetOperationType=string

Синтаксис JSON:

{
  "StackSetAccounts": ["string", ...],
  "StackSetRegions": ["string", ...],
  "StackSetFailureToleranceCount": integer,
  "StackSetFailureTolerancePercentage": integer,
  "StackSetMaxConcurrencyCount": integer,
  "StackSetMaxConcurrencyPercentage": integer,
  "StackSetOperationType": "CREATE"|"UPDATE"|"DELETE"
}

--tags (список)

Один или несколько тегов. Требует, чтобы у продукта было ограничение RESOURCE_UPDATE с TagUpdatesOnProvisionedProduct, установленным в ALLOWED, для разрешения обновления тегов.

(структура)

Информация о теге. Тег — это пара ключ-значение. Теги распространяются на ресурсы, созданные при подготовке продукта.

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

Ключ тега.

Значение -> (строка)

Значение для этого ключа.

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

Key=string,Value=string ...

Синтаксис JSON:

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

--update-token (строка)

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком 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.

Вывод

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

Информация о результате запроса.

RecordId -> (строка)

Идентификатор записи.

ProvisionedProductName -> (строка)

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

Status -> (строка)

Статус предоставленного продукта.

  • CREATED - Запрос создан, но операция еще не началась.
  • IN_PROGRESS - Запрошенная операция выполняется.
  • IN_PROGRESS_IN_ERROR - Предоставленный продукт находится в процессе изменения, но запрошенная операция завершилась неудачно, и происходит исправление. Например, откат.
  • SUCCEEDED - Запрошенная операция успешно завершена.
  • FAILED - Запрошенная операция завершилась неудачно. Исследуйте, используя возвращенные сообщения об ошибках.

CreatedTime -> (метка времени)

Метка времени UTC времени создания.

UpdatedTime -> (метка времени)

Время последнего обновления записи.

ProvisionedProductType -> (строка)

Тип предоставленного продукта. Поддерживаемые значения — CFN_STACK , CFN_STACKSET , TERRAFORM_OPEN_SOURCE , TERRAFORM_CLOUD и EXTERNAL .

RecordType -> (строка)

Тип записи.

  • PROVISION_PRODUCT
  • UPDATE_PROVISIONED_PRODUCT
  • TERMINATE_PROVISIONED_PRODUCT

ProvisionedProductId -> (строка)

Идентификатор предоставленного продукта.

ProductId -> (строка)

Идентификатор продукта.

ProvisioningArtifactId -> (строка)

Идентификатор артефакта предоставления.

PathId -> (строка)

Идентификатор пути.

RecordErrors -> (список)

Возникшие ошибки.

(структура)

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

Code -> (строка)

Числовое значение ошибки.

Description -> (строка)

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

RecordTags -> (список)

Один или несколько тегов.

(структура)

Информация о теге, который представляет собой пару ключ-значение.

Key -> (строка)

Ключ для этого тега.

Value -> (строка)

Значение для этого тега.

LaunchRoleArn -> (строка)

ARN роли запуска, связанной с предоставленным продуктом.

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

Spec-Zone.ru

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