Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

provision-product

Описание

Запускает указанный продукт.

Запущенный продукт — это экземпляр ресурса продукта. Например, запуск продукта, основанного на шаблоне CloudFormation, запускает стеки CloudFormation и его связанные ресурсы. Вы можете проверить статус этого запроса, используя DescribeRecord.

Если запрос содержит ключ тега со списком значений, пустым, существует конфликт тегов для данного ключа. Не включайте конфликтующие ключи в качестве тегов, иначе это вызовет ошибку «Ошибка валидации параметра: Не хватает обязательного параметра в Tags[N ]:Value».

Примечание

При запуске продукта, добавленного в портфель, вы должны предоставить пользователю, группе или роли доступ к портфелю. Дополнительные сведения см. в разделе «Предоставление пользователям доступа» в Руководстве пользователя Service Catalog.

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

Синтаксис

  provision-product
[--accept-language <value>]
[--product-id <value>]
[--product-name <value>]
[--provisioning-artifact-id <value>]
[--provisioning-artifact-name <value>]
[--path-id <value>]
[--path-name <value>]
--provisioned-product-name <value>
[--provisioning-parameters <value>]
[--provisioning-preferences <value>]
[--tags <value>]
[--notification-arns <value>]
[--provision-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 — Китайский

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

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

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

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

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

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

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

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

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

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

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

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

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

Наглядное имя запущенного продукта. Это значение должно быть уникальным для учетной записи Amazon Web Services и не может быть обновлено после запуска продукта.

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

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

(структура)

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

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

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

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

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

Синтаксис сокращенного представления:

Key=string,Value=string ...

Синтаксис JSON:

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

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

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

StackSetAccounts -> (список)

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

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

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

Синтаксис сокращенного представления:

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

Синтаксис JSON:

{
  "StackSetAccounts": ["string", ...],
  "StackSetRegions": ["string", ...],
  "StackSetFailureToleranceCount": integer,
  "StackSetFailureTolerancePercentage": integer,
  "StackSetMaxConcurrencyCount": integer,
  "StackSetMaxConcurrencyPercentage": integer
}

--tags (список)

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

(структура)

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

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

Ключ тега.

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

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

Синтаксис сокращенного представления:

Key=string,Value=string ...

Синтаксис JSON:

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

--notification-arns (список)

Передается CloudFormation. ARNs тем SNS, в которые будут публиковаться события, связанные со стеками.

(строка)

Синтаксис:

"string" "string" ...

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

Примеры

Примечание

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

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

Для развертывания продукта

Следующий provision-product пример развертывает указанный продукт с использованием указанного артефакта развертывания.

aws servicecatalog provision-product \
    --product-id prod-abcdfz3syn2rg \
    --provisioning-artifact-id pa-abc347pcsccfm \
    --provisioned-product-name "mytestppname3"

Вывод:

{
    "RecordDetail": {
        "RecordId": "rec-tfuawdabcdege",
        "CreatedTime": 1577222793.362,
        "ProvisionedProductId": "pp-abcd27bm4mldq",
        "PathId": "lpv2-abcdg3jp6t5k6",
        "RecordErrors": [],
        "ProductId": "prod-abcdfz3syn2rg",
        "UpdatedTime": 1577222793.362,
        "RecordType": "PROVISION_PRODUCT",
        "ProvisionedProductName": "mytestppname3",
        "ProvisioningArtifactId": "pa-pcz347abcdcfm",
        "RecordTags": [],
        "Status": "CREATED",
        "ProvisionedProductType": "CFN_STACK"
    }
}

Вывод

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