Spec-Zone.ru › AWS CLI v2

[ aws . workspaces ]

изменить-свойства-создания-рабочих-столов

Описание

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

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

Синтаксис

  modify-workspace-creation-properties
--resource-id <value>
--workspace-creation-properties <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]

Параметры

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

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

--workspace-creation-properties (структура)

Свойства по умолчанию для создания рабочих столов WorkSpaces.

EnableInternetAccess -> (булево)

Указывает, включён ли доступ в интернет для ваших рабочих столов WorkSpaces.

DefaultOu -> (строка)

Узел организационной структуры (OU) по умолчанию для ваших каталогов рабочих столов WorkSpaces. Эта строка должна быть полным отличительным именем LDAP (Lightweight Directory Access Protocol) для целевого домена и OU. Она должна иметь вид "OU=*value* ,DC=*value* ,DC=*value* " , где value — любая строка символов, а число компонентов домена (DC) — два или более. Например, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com .

Предупреждение

  • Для предотвращения ошибок определённые символы в отличительном имени должны быть экранированы. Дополнительную информацию см. в документации Microsoft по отличительным именам.
  • API не проверяет, существует ли OU.

CustomSecurityGroupId -> (строка)

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

UserEnabledAsLocalAdministrator -> (булево)

Указывает, являются ли пользователи локальными администраторами своих рабочих столов WorkSpaces.

EnableMaintenanceMode -> (булево)

Указывает, включен ли режим технического обслуживания для ваших рабочих столов WorkSpaces. Дополнительную информацию см. в разделе Техническое обслуживание WorkSpace.

InstanceIamRoleArn -> (строка)

Указывает ARN роли IAM экземпляра.

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

EnableInternetAccess=boolean,DefaultOu=string,CustomSecurityGroupId=string,UserEnabledAsLocalAdministrator=boolean,EnableMaintenanceMode=boolean,InstanceIamRoleArn=string

Синтаксис JSON:

{
  "EnableInternetAccess": true|false,
  "DefaultOu": "string",
  "CustomSecurityGroupId": "string",
  "UserEnabledAsLocalAdministrator": true|false,
  "EnableMaintenanceMode": true|false,
  "InstanceIamRoleArn": "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
  • 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-auto-prompt (булево)

Автоматически запрашивать входные данные CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы входных данных CLI.

Примеры

Примечание

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

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

Для изменения свойства создания рабочего стола каталога

В следующем modify-workspace-creation-properties примере включается EnableInternetAccess свойство для указанного каталога. Это включает автоматическое назначение общедоступных IP-адресов для рабочих столов, созданных для каталога.

aws workspaces modify-workspace-creation-properties \
    --resource-id d-926722edaf \
    --workspace-creation-properties EnableInternetAccess=true

Эта команда не генерирует вывод.

Дополнительную информацию см. в разделе Обновление подробностей каталога для ваших рабочих столов в руководстве по администрированию Amazon WorkSpaces.

Вывод

Нет

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

Spec-Zone.ru

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