Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

обновить-псевдоним

Описание

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

Связанные действия

Все API по задаче

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

Синтаксис

  update-alias
--alias-id <value>
[--name <value>]
[--description <value>]
[--routing-strategy <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]

Параметры

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

Уникальный идентификатор псевдонима, который требуется обновить. Можно использовать либо ID псевдонима, либо значение ARN.

--name (строка)

Дескриптивное имя, связанное с псевдонимом. Имена псевдонимов не должны быть уникальными.

--description (строка)

Описание псевдонима, понятное пользователю.

--routing-strategy (структура)

Конфигурация маршрутизации, включая тип маршрутизации и целевой флот для псевдонима.

Тип -> (строка)

Тип стратегии маршрутизации для псевдонима.

Возможные типы маршрутизации включают:

  • ПРОСТЫЙ - псевдоним разрешается на один конкретный флот. Используйте этот тип при маршрутизации к активным флотам.
  • КОНЕЧНЫЙ - псевдоним не разрешается на флот, но вместо этого может использоваться для отображения сообщения пользователю. Псевдоним «КОНЕЧНЫЙ» генерирует исключение TerminalRoutingStrategyException с встроенным сообщением.

FleetId -> (строка)

Уникальный идентификатор флота, к которому указывает псевдоним. Это значение — ID флота, а не ARN флота.

Сообщение -> (строка)

Текст сообщения, используемый со стратегией маршрутизации «КОНЕЧНЫЙ».

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

Type=string,FleetId=string,Message=string

Синтаксис JSON:

{
  "Type": "SIMPLE"|"TERMINAL",
  "FleetId": "string",
  "Message": "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.

Вывод

Псевдоним -> (структура)

Обновлённый ресурс псевдонима.

AliasId -> (строка)

Уникальный идентификатор псевдонима. ID псевдонима уникален в рамках региона.

Name -> (строка)

Дескриптивное имя, связанное с псевдонимом. Имена псевдонимов не должны быть уникальными.

AliasArn -> (строка)

Amazon Resource Name (ARN) псевдонима Amazon GameLift и уникально его идентифицирует. ARNs уникальны для всех регионов. Формат — arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. В ARN псевдонима GameLift идентификатор ресурса соответствует значению ID псевдонима.

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

Описание псевдонима, понятное пользователю.

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

Конфигурация маршрутизации, включая тип маршрутизации и целевой флот для псевдонима.

Тип -> (строка)

Тип стратегии маршрутизации для псевдонима.

Возможные типы маршрутизации включают:

  • ПРОСТЫЙ - псевдоним разрешается на один конкретный флот. Используйте этот тип при маршрутизации к активным флотам.
  • КОНЕЧНЫЙ - псевдоним не разрешается на флот, но вместо этого может использоваться для отображения сообщения пользователю. Псевдоним «КОНЕЧНЫЙ» генерирует исключение TerminalRoutingStrategyException с встроенным сообщением.

FleetId -> (строка)

Уникальный идентификатор флота, к которому указывает псевдоним. Это значение — ID флота, а не ARN флота.

Сообщение -> (строка)

Текст сообщения, используемый со стратегией маршрутизации «КОНЕЧНЫЙ».

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

Маркер времени, показывающий, когда был создан этот объект данных. Формат — число, выраженное в миллисекундах времени Unix (например, "1469498468.057").

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

Время последнего изменения этого объекта данных. Формат — число, выраженное в миллисекундах времени Unix (например, "1469498468.057").

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

Spec-Zone.ru

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