[ aws . appstream ]

обновить-флот

Описание

Обновляет указанный флот.

Если флот находится в состоянии STOPPED, вы можете обновить любой атрибут, кроме имени флота.

Если флот находится в состоянии RUNNING, вы можете обновить следующие параметры в зависимости от типа флота:

Флоты типов Always-On и On-Demand Вы можете обновить атрибуты DisplayName , ComputeCapacity , ImageARN , ImageName , IdleDisconnectTimeoutInSeconds и DisconnectTimeoutInSeconds.
Флоты типа Elastic Вы можете обновить атрибуты DisplayName , IdleDisconnectTimeoutInSeconds , DisconnectTimeoutInSeconds , MaxConcurrentSessions , SessionScriptS3Location и UsbDeviceFilterStrings.

Если флот находится в состоянии STARTING или STOPPED, его нельзя обновить.

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

Синтаксис

  update-fleet
[--image-name <value>]
[--image-arn <value>]
[--name <value>]
[--instance-type <value>]
[--compute-capacity <value>]
[--vpc-config <value>]
[--max-user-duration-in-seconds <value>]
[--disconnect-timeout-in-seconds <value>]
[--delete-vpc-config | --no-delete-vpc-config]
[--description <value>]
[--display-name <value>]
[--enable-default-internet-access | --no-enable-default-internet-access]
[--domain-join-info <value>]
[--idle-disconnect-timeout-in-seconds <value>]
[--attributes-to-delete <value>]
[--iam-role-arn <value>]
[--stream-view <value>]
[--platform <value>]
[--max-concurrent-sessions <value>]
[--usb-device-filter-strings <value>]
[--session-script-s3-location <value>]
[--max-sessions-per-instance <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]

Параметры

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

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

--image-arn (строка)

ARN публичного, частного или общего изображения для использования.

--name (строка)

Уникальное имя для флота.

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

Тип экземпляра, используемого при запуске экземпляров флота. Доступны следующие типы экземпляров:

stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge

Следующие типы экземпляров доступны для эластичных флотов:

stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge

--compute-capacity (структура)

Желаемая ёмкость флота. Это не разрешено для эластичных флотов.

DesiredInstances -> (целое число)

Желаемое количество экземпляров потоковой передачи.

DesiredSessions -> (целое число)

Желаемое количество пользовательских сессий для флота с несколькими сессиями. Это не разрешено для флотов с одной сессией.

При создании флота необходимо установить атрибут DesiredSessions или DesiredInstances, в зависимости от типа создаваемого флота. Вы не можете определить оба атрибута или оставить оба атрибута пустыми.

Сокращенная синтаксическая запись:

DesiredInstances=integer,DesiredSessions=integer

Синтаксис JSON:

{
  "DesiredInstances": integer,
  "DesiredSessions": integer
}

--vpc-config (структура)

Настройка VPC для флота. Это обязательно для эластичных флотов, но не обязательно для других типов флотов. Эластичные флоты требуют указать по крайней мере два подсети в разных зонах доступности.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

Идентификаторы групп безопасности для флота или сборщика изображений.

(строка)

Сокращенная синтаксическая запись:

SubnetIds=string,string,SecurityGroupIds=string,string

Синтаксис JSON:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--max-user-duration-in-seconds (целое число)

Максимальное время активности сессии потоковой передачи в секундах. Если пользователи по-прежнему подключены к экземпляру потоковой передачи за пять минут до достижения этого предела, им предлагается сохранить все открытые документы перед отключением. По истечении этого времени экземпляр завершается и заменяется новым.

Укажите значение от 600 до 432000.

--disconnect-timeout-in-seconds (целое число)

Время активности сессии потоковой передачи после отключения пользователей. Если пользователи пытаются повторно подключиться к сессии потоковой передачи после отключения или прерывания сети в этом интервале времени, они подключаются к своей предыдущей сессии. В противном случае они подключаются к новой сессии с новым экземпляром потоковой передачи.

Укажите значение от 60 до 36000.

--delete-vpc-config | --no-delete-vpc-config (булево)

Удаляет ассоциацию VPC для указанного флота.

--description (строка)

Отображаемое описание.

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

Отображаемое имя флота.

--enable-default-internet-access | --no-enable-default-internet-access (булево)

Включает или отключает стандартный доступ к интернету для флота.

--domain-join-info (структура)

Имя каталога и организационной единицы (OU) для присоединения флота к домену Microsoft Active Directory.

DirectoryName -> (строка)

Полное имя каталога (например, corp.example.com).

OrganizationalUnitDistinguishedName -> (строка)

Выраженный идентификатор организационной единицы для учетных записей компьютеров.

Сокращенная синтаксическая запись:

DirectoryName=string,OrganizationalUnitDistinguishedName=string

Синтаксис JSON:

{
  "DirectoryName": "string",
  "OrganizationalUnitDistinguishedName": "string"
}

--idle-disconnect-timeout-in-seconds (целое число)

Время, в течение которого пользователи могут быть бездействующими (неактивными), прежде чем они будут отключены от своей сессии потоковой передачи, и начнется интервал времени DisconnectTimeoutInSeconds. Пользователям сообщается об этом перед отключением из-за бездействия. Если пользователи пытаются повторно подключиться к сессии потоковой передачи до истечения интервала времени, указанного в DisconnectTimeoutInSeconds, они подключаются к своей предыдущей сессии. Пользователи считаются бездействующими, когда они прекращают ввод с клавиатуры или мыши во время сессии потоковой передачи. Загрузка и загрузка файлов, аудио ввод/вывод и изменение пикселей не считаются активностью пользователя. Если пользователи продолжают бездействовать после истечения интервала времени в IdleDisconnectTimeoutInSeconds, они отключаются.

Чтобы предотвратить отключение пользователей из-за бездействия, укажите значение 0. В противном случае укажите значение от 60 до 36000. Значение по умолчанию равно 0.

Примечание

Если вы включили эту функцию, мы рекомендуем указать значение, которое точно соответствует целому числу минут (например, 60, 120 и 180). Если вы этого не сделаете, значение округляется до ближайшей минуты. Например, если вы укажете значение 70, пользователи отключаются после 1 минуты бездействия. Если вы укажете значение, которое находится на середине между двумя разными минутами, значение округляется вверх. Например, если вы укажете значение 90, пользователи отключаются после 2 минут бездействия.

--attributes-to-delete (список)

Атрибуты флота, которые необходимо удалить.

(строка)

Атрибут флота.

Синтаксис:

"string" "string" ...

Where valid values are:
  VPC_CONFIGURATION
  VPC_CONFIGURATION_SECURITY_GROUP_IDS
  DOMAIN_JOIN_INFO
  IAM_ROLE_ARN
  USB_DEVICE_FILTER_STRINGS
  SESSION_SCRIPT_S3_LOCATION
  MAX_SESSIONS_PER_INSTANCE

--iam-role-arn (строка)

Amazon Resource Name (ARN) роли IAM, применяемой к флоту. Для получения прав доступа экземпляр флота обращается к AWS Security Token Service (STS) AssumeRole API-операции и передает ARN используемой роли. Операция создаёт новую сессию с временными учетными данными. AppStream 2.0 получает временные учетные данные и создаёт профиль учетных данных appstream_machine_role на экземпляре.

Дополнительную информацию см. в разделе Использование роли IAM для предоставления разрешений приложениям и скриптам, выполняемым на экземплярах потоковой передачи AppStream 2.0 в руководстве по администрированию Amazon AppStream 2.0.

--stream-view (строка)

Представление AppStream 2.0, отображаемое пользователям при потоковой передаче из флота. Если задано APP, отображаются только окна приложений, открытых пользователями. Если задано DESKTOP, отображается стандартный рабочий стол, предоставляемый операционной системой.

Значение по умолчанию равно APP.

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

APP
DESKTOP

--platform (строка)

Платформа флота. WINDOWS_SERVER_2019 и AMAZON_LINUX2 поддерживаются для эластичных флотов.

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

WINDOWS
WINDOWS_SERVER_2016
WINDOWS_SERVER_2019
WINDOWS_SERVER_2022
AMAZON_LINUX2
RHEL8
ROCKY_LINUX8

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

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

--usb-device-filter-strings (список)

Строки фильтра USB-устройств, определяющие, какие USB-устройства пользователь может перенаправить в сессию потоковой передачи флота при использовании Windows-клиента. Это разрешено, но не обязательно для эластичных флотов.

(строка)

Синтаксис:

"string" "string" ...

--session-script-s3-location (структура)

Расположение S3 конфигурационного zip-файла скриптов сессии. Это применимо только к эластичным флотам.

S3Bucket -> (строка)

Ведро S3 объекта.

S3Key -> (строка)

Ключ S3 объекта.

Это необходимо при использовании для следующего:

IconS3Location (Действия: CreateApplication и UpdateApplication)
SessionScriptS3Location (Действия: CreateFleet и UpdateFleet)
ScriptDetails (Действия: CreateAppBlock)
SourceS3Location при создании блока приложений с CUSTOM PackagingType (Действия: CreateAppBlock)
SourceS3Location при создании блока приложений с APPSTREAM2 PackagingType и использовании существующего пакета приложений (файл VHD). В этом случае S3Key относится к файлу VHD. Если требуется новый пакет приложений, то S3Key не требуется. (Действия: CreateAppBlock)

Сокращенная синтаксическая запись:

S3Bucket=string,S3Key=string

Синтаксис JSON:

{
  "S3Bucket": "string",
  "S3Key": "string"
}

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

Максимальное количество пользовательских сессий на экземпляре. Это применимо только к флотам с несколькими сессиями.

--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
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

on
off
auto

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

Вывод

Флот -> (структура)

Информация о флоте.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) флота.

Name -> (строка)

Название флота.

DisplayName -> (строка)

Имя флота для отображения.

Description -> (строка)

Описание для отображения.

ImageName -> (строка)

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

ImageArn -> (строка)

ARN для публичного, частного или общего образа.

InstanceType -> (строка)

Тип экземпляра для запуска экземпляров флота. Доступны следующие типы экземпляров:

stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge

FleetType -> (строка)

Тип флота.

ALWAYS_ON

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

ON_DEMAND

Предоставляет пользователям доступ к приложениям после подключения, что занимает одну-две минуты. Вы оплачиваете трансляцию экземпляров, когда пользователи подключены, и небольшую часовую плату за экземпляры, которые не транслируют приложения.

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

Состояние емкости флота.

Desired -> (целое число)

Желаемое количество экземпляров потоковой передачи.

Running -> (целое число)

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

InUse -> (целое число)

Количество экземпляров, используемых для потоковой передачи.

Available -> (целое число)

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

DesiredUserSessions -> (целое число)

Общее количество слотов сеансов, которые находятся в работе или ожидании. Это общее количество одновременных сеансов потоковой передачи, которые может поддерживать ваш флот в стабильном состоянии.

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

Это относится только к многосеансовым флотам.

AvailableUserSessions -> (целое число)

Количество свободных слотов сеансов, доступных для пользовательских сеансов.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

Это относится только к многосеансовым флотам.

ActiveUserSessions -> (целое число)

Количество пользовательских сеансов, которые в настоящее время используются для сеансов потоковой передачи. Это относится только к многосеансовым флотам.

ActualUserSessions -> (целое число)

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

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

Это относится только к многосеансовым флотам.

MaxUserDurationInSeconds -> (целое число)

Максимальное время активности сеанса потоковой передачи в секундах. Если пользователи все еще подключены к экземпляру потоковой передачи за пять минут до достижения этого предела, им предлагается сохранить все открытые документы перед отключением. По истечении этого времени экземпляр завершается и заменяется новым экземпляром.

Укажите значение от 600 до 360000.

DisconnectTimeoutInSeconds -> (целое число)

Время, в течение которого сеанс потоковой передачи остается активным после отключения пользователей. Если они пытаются повторно подключиться к сеансу потоковой передачи после отключения или прерывания сети в течение этого интервала времени, они подключаются к своему предыдущему сеансу. В противном случае они подключаются к новому сеансу с новым экземпляром потоковой передачи.

Укажите значение от 60 до 36000.

State -> (строка)

Текущее состояние флота.

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

Настройка VPC для флота.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Время создания флота.

FleetErrors -> (список)

Ошибки флота.

(структура)

Описание ошибки флота.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

EnableDefaultInternetAccess -> (булево)

Указывает, включен ли по умолчанию доступ к интернету для флота.

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

Имя каталога и организационной единицы (OU) для подключения флота к домену Microsoft Active Directory.

DirectoryName -> (строка)

Полное доменное имя каталога (например, corp.example.com).

OrganizationalUnitDistinguishedName -> (строка)

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

IdleDisconnectTimeoutInSeconds -> (целое число)

Время, в течение которого пользователи могут быть бездействующими (неактивными), прежде чем они будут отключены от сеанса потоковой передачи, и начнется интервал времени DisconnectTimeoutInSeconds. Пользователи уведомляются перед отключением из-за бездействия. Если пользователи пытаются повторно подключиться к сеансу потоковой передачи до истечения интервала времени, указанного в DisconnectTimeoutInSeconds, они подключаются к своему предыдущему сеансу. Пользователи считаются бездействующими, когда они перестают предоставлять входные данные клавиатуры или мыши во время сеанса потоковой передачи. Загрузка и загрузка файлов, аудио вход, аудио выход и изменение пикселей не считаются активностью пользователя. Если пользователи продолжают бездействовать после истечения интервала времени в IdleDisconnectTimeoutInSeconds, они отключаются.

Примечание

Если вы включите эту функцию, мы рекомендуем указать значение, которое точно соответствует целому числу минут (например, 60, 120 и 180). Если вы этого не сделаете, значение округляется до ближайшей минуты. Например, если вы укажете значение 70, пользователи отключаются после 1 минуты бездействия. Если вы укажете значение, которое находится посередине между двумя разными минутами, значение округляется вверх. Например, если вы укажете значение 90, пользователи отключаются после 2 минут бездействия.

IamRoleArn -> (строка)

ARN роли IAM, которая применяется к флоту. Для принятия роли экземпляр флота вызывает операцию API AWS Security Token Service (STS) AssumeRole и передает ARN роли для использования. Операция создает новую сессию со временными учетными данными. AppStream 2.0 извлекает временные учетные данные и создает профиль учетных данных appstream_machine_role на экземпляре.

Дополнительную информацию см. в разделе Использование роли IAM для предоставления разрешений приложениям и сценариям, выполняемым на экземплярах потоковой передачи AppStream 2.0, в Руководстве по администрированию Amazon AppStream 2.0.

StreamView -> (строка)

Вид AppStream 2.0, который отображается пользователям при потоковой передаче из флота. Когда APP указан, отображаются только окна приложений, открытых пользователями. Когда DESKTOP указан, отображается стандартный рабочий стол, предоставляемый операционной системой.

Значение по умолчанию — APP.

Platform -> (строка)

Платформа флота.

MaxConcurrentSessions -> (целое число)

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

UsbDeviceFilterStrings -> (список)

Строки фильтра USB-устройств, связанные с флотом.

(строка)

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

Расположение сценариев сеанса в S3 в формате zip-архива. Это относится только к эластичным флотам.

S3Bucket -> (строка)

Ведро S3 объекта.

S3Key -> (строка)

Ключ S3 объекта.

Это требуется при использовании для следующего:

IconS3Location (Действия: CreateApplication и UpdateApplication)
SessionScriptS3Location (Действия: CreateFleet и UpdateFleet)
ScriptDetails (Действия: CreateAppBlock)
SourceS3Location при создании блока приложений с CUSTOM PackagingType (Действия: CreateAppBlock)
SourceS3Location при создании блока приложений с APPSTREAM2 PackagingType и использовании существующего пакета приложений (файл VHD). В этом случае S3Key относится к файлу VHD. Если требуется новый пакет приложений, то S3Key не требуется. (Действия: CreateAppBlock)

MaxSessionsPerInstance -> (целое число)

Максимальное количество пользовательских сеансов на одном экземпляре. Это относится только к многосеансовым флотам.