Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

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

Описание

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

Amazon GameLift поддерживает два типа стратегий маршрутизации для псевдонимов: простые и терминальные. Простой псевдоним указывает на активный флот. Терминальный псевдоним используется для отображения сообщений или ссылки на URL-адрес вместо маршрутизации игроков на активный флот. Например, вы можете использовать терминальный псевдоним, когда версия игры больше не поддерживается, и вы хотите направить игроков на сайт обновления.

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

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

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

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

Синтаксис

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

Параметры

--name (строка)

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

--description (строка)

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

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

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

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

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

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

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

FleetId -> (строка)

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

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

Текст сообщения, используемого со стратегией терминальной маршрутизации.

Краткая запись:

Type=string,FleetId=string,Message=string

Синтаксис JSON:

{
  "Type": "SIMPLE"|"TERMINAL",
  "FleetId": "string",
  "Message": "string"
}

--tags (список)

Список меток для назначения новому ресурсу псевдонима. Метки — это пары ключ-значение, определяемые разработчиком. Метки ресурсов Amazon Web Services полезны для управления ресурсами, управления доступом и распределения затрат. Дополнительную информацию см. в разделе Метки ресурсов Amazon Web Services в Справочнике Amazon Web Services.

(структура)

Метка, которую вы можете назначить ресурсу Amazon GameLift.

Дополнительная информация

Метки ресурсов Amazon Web Services в Справочнике Amazon Web Services

Стратегии метки Amazon Web Services

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

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

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

Ключ для пары ключ-значение, определяемой разработчиком, для метки ресурса Amazon Web Services.

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

Значение для пары ключ-значение, определяемой разработчиком, для метки ресурса Amazon Web Services.

Краткая запись:

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.

Вывод

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

Недавно созданный ресурс псевдонима.

AliasId -> (строка)

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

Имя -> (строка)

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

AliasArn -> (строка)

Amazon Resource Name (ARN), назначенный ресурсу псевдонима Amazon GameLift и уникально его идентифицирующий. ARN уникальны во всех регионах. Формат — 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