Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

создание-экземпляра

Описание

Позволяет программно создать экземпляр Amazon Web Services Supply Chain, применяя ключи KMS и соответствующую информацию, связанную с API, без использования консоли Amazon Web Services.

Это асинхронная операция. При получении запроса CreateInstance Amazon Web Services Supply Chain немедленно возвращает ресурс экземпляра, идентификатор экземпляра и начальное состояние, одновременно создавая все необходимые ресурсы Amazon Web Services для создания экземпляра. Вы можете использовать GetInstance для проверки состояния экземпляра. Если экземпляр находится в нерабочем состоянии, вам необходимо проверить сообщение об ошибке, удалить текущий экземпляр и создать новый на основе рекомендаций из сообщения об ошибке.

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

Синтаксис

  create-instance
[--instance-name <value>]
[--instance-description <value>]
[--kms-key-arn <value>]
[--web-app-dns-domain <value>]
[--tags <value>]
[--client-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]

Параметры

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

Имя экземпляра AWS Supply Chain.

--instance-description (строка)

Описание экземпляра AWS Supply Chain.

--kms-key-arn (строка)

ARN (Amazon Resource Name) ключа службы управления ключами (KMS), который вы предоставляете для шифрования. Это необходимо, если вы не хотите использовать собственный ключ KMS Amazon Web Services. Если вы ничего не укажете здесь, AWS Supply Chain будет использовать собственный ключ KMS Amazon Web Services.

--web-app-dns-domain (строка)

Поддомен DNS веб-приложения. В URL «example.scn.global.on.aws» это будет «example». Вы можете задать это значение произвольное, если только домен не используется кем-то другим. Имя может содержать только буквенно-цифровые символы и дефисы.

--tags (карта)

Теги Amazon Web Services экземпляра, который будет создан.

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

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

Сокращенная форма записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--client-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 (логическое значение)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

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

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

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • текст
  • таблица
  • 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 Supply Chain.

instanceId -> (строка)

Идентификатор экземпляра Amazon Web Services Supply Chain.

awsAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей экземпляром.

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

Состояние экземпляра.

errorMessage -> (строка)

Сообщение об ошибке экземпляра Amazon Web Services Supply Chain. Если экземпляр находится в нерабочем состоянии, пользователи должны проверить сообщение об ошибке, удалить текущий экземпляр и создать новый на основе рекомендаций из сообщения об ошибке.

webAppDnsDomain -> (строка)

Имя домена DNS веб-приложения экземпляра.

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

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

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

Отметка времени последнего изменения экземпляра.

instanceName -> (строка)

Имя экземпляра Amazon Web Services Supply Chain.

instanceDescription -> (строка)

Описание экземпляра Amazon Web Services Supply Chain.

kmsKeyArn -> (строка)

ARN (Amazon Resource Name) ключа службы управления ключами (KMS), который вы необязательно предоставили для шифрования. Если вы ничего не предоставили, AWS Supply Chain использует собственный ключ KMS Amazon Web Services и ничего не возвращает.

versionNumber -> (двойное число)

Номер версии экземпляра.

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

Spec-Zone.ru

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