Spec-Zone.ru › AWS CLI v2

[ aws . workspaces ]

create-standby-workspaces

Описание

Создаёт резервный WorkSpace в дополнительной Регионе.

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

Синтаксис

  create-standby-workspaces
--primary-region <value>
--standby-workspaces <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]

Параметры

--primary-region (строка)

Регион первичного WorkSpace.

--standby-workspaces (список)

Информация о создаваемом резервном WorkSpace.

(структура)

Описание резервного WorkSpace.

PrimaryWorkspaceId -> (строка)

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

VolumeEncryptionKey -> (строка)

Ключ шифрования тома резервного WorkSpace.

DirectoryId -> (строка)

Идентификатор каталога для резервного WorkSpace.

Tags -> (список)

Теги, связанные с резервным WorkSpace.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Value -> (строка)

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

DataReplication -> (строка)

Указывает, включена ли репликация данных, и если включена, тип репликации данных.

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

PrimaryWorkspaceId=string,VolumeEncryptionKey=string,DirectoryId=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}],DataReplication=string ...

Синтаксис JSON:

[
  {
    "PrimaryWorkspaceId": "string",
    "VolumeEncryptionKey": "string",
    "DirectoryId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ],
    "DataReplication": "NO_REPLICATION"|"PRIMARY_AS_SOURCE"
  }
  ...
]

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

Вывод

FailedStandbyRequests -> (список)

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

(структура)

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

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

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

PrimaryWorkspaceId -> (строка)

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

VolumeEncryptionKey -> (строка)

Ключ шифрования тома резервного WorkSpace.

DirectoryId -> (строка)

Идентификатор каталога для резервного WorkSpace.

Tags -> (список)

Теги, связанные с резервным WorkSpace.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Value -> (строка)

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

DataReplication -> (строка)

Указывает, включена ли репликация данных, и если включена, тип репликации данных.

ErrorCode -> (строка)

Код ошибки, возвращаемый, если резервный WorkSpace не был создан.

ErrorMessage -> (строка)

Текст сообщения об ошибке, возвращаемый, если резервный WorkSpace не был создан.

PendingStandbyRequests -> (список)

Информация о резервном WorkSpace, который был создан.

(структура)

Информация о резервном WorkSpace.

UserName -> (строка)

Описание созданного резервного WorkSpace.

Поскольку эта операция является асинхронной, возвращаемый идентификатор не сразу доступен для использования с другими операциями. Например, если вы вызовете DescribeWorkspaces до создания WorkSpace, возвращаемая информация может быть неполной.

DirectoryId -> (строка)

Идентификатор каталога для резервного WorkSpace.

State -> (строка)

Операционное состояние резервного WorkSpace.

WorkspaceId -> (строка)

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

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

Spec-Zone.ru

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