Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-web ]

создание-портала

Описание

Создаёт веб-портал.

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

Синтаксис

  create-portal
[--additional-encryption-context <value>]
[--authentication-type <value>]
[--client-token <value>]
[--customer-managed-key <value>]
[--display-name <value>]
[--instance-type <value>]
[--max-concurrent-sessions <value>]
[--tags <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]

Параметры

--additional-encryption-context (карта)

Дополнительный контекст шифрования портала.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--authentication-type (строка)

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

Standard веб-порталы аутентифицируются напрямую через ваш поставщик удостоверений. Вам необходимо вызвать CreateIdentityProvider, чтобы интегрировать ваш поставщик удостоверений с вашим веб-порталом. Доступ пользователей и групп к вашему веб-порталу контролируется вашим поставщиком удостоверений.

IAM Identity Center веб-порталы аутентифицируются через IAM Identity Center. Источники удостоверений (включая интеграцию с внешним поставщиком удостоверений), а также доступ пользователей и групп к вашему веб-порталу можно настроить в IAM Identity Center.

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

  • Standard
  • IAM_Identity_Center

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы гарантировать идемпотентность запроса. Идемпотентность гарантирует, что запрос API выполняется только один раз. При идемпотентном запросе, если исходный запрос завершился успешно, повторные запросы с тем же токеном клиента возвращают результат из исходного успешного запроса.

Если вы не укажете токен клиента, он автоматически сгенерируется Amazon Web Services SDK.

--customer-managed-key (строка)

Управляемый клиентом ключ веб-портала.

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

Название веб-портала. Оно не отображается пользователям, которые входят на веб-портал.

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

Тип и ресурсы базового экземпляра.

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

  • standard.regular
  • standard.large
  • standard.xlarge

--max-concurrent-sessions (целое число)

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

--tags (список)

Теги, которые нужно добавить к веб-порталу. Тег — это пара "ключ-значение".

(структура)

Тег.

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

Ключ тега.

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

Значение тега

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

Key=string,Value=string ...

Синтаксис JSON:

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

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

Вывод

portalArn -> (строка)

ARN веб-портала.

portalEndpoint -> (строка)

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

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

Spec-Zone.ru

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