Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

обновить-определение-группы-контейнеров

Описание

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

Единственное свойство, которое нельзя обновить, — это тип группы контейнеров.

Параметры запроса:
  • Обновление на основе последней версии определения группы контейнеров. Укажите только имя определения группы контейнеров или используйте значение ARN без номера версии. Предоставьте обновленные значения только для тех свойств, которые вы хотите изменить. Все остальные значения останутся такими же, как в последней версии.
  • Обновление на основе определенной версии определения группы контейнеров. Укажите имя определения группы контейнеров и номер исходной версии или используйте значение ARN с номером версии. Предоставьте обновленные значения только для тех свойств, которые вы хотите изменить. Все остальные значения останутся такими же, как в исходной версии.
  • Изменение определения контейнера сервера игр. Предоставьте обновленное определение контейнера.
  • Добавление или изменение определения контейнера поддержки. Предоставьте полный набор определений контейнеров, включая обновленное определение.
  • Удаление определения контейнера поддержки. Предоставьте полный набор определений контейнеров, исключая удаляемое определение. Если в группе контейнеров есть только одно определение контейнера поддержки, предоставьте пустой набор.
Результаты:

При успешном выполнении данная операция возвращает полные свойства новой версии определения группы контейнеров.

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

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

Синтаксис

  update-container-group-definition
--name <value>
[--game-server-container-definition <value>]
[--support-container-definitions <value>]
[--total-memory-limit-mebibytes <value>]
[--total-vcpu-limit <value>]
[--version-description <value>]
[--source-version-number <value>]
[--operating-system <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 (строка)

Дескриптивный идентификатор для определения группы контейнеров. Значение имени должно быть уникальным в регионе Amazon Web Services.

--game-server-container-definition (структура)

Обновленное определение контейнера сервера игр в этой группе. Определяйте контейнер сервера игр только тогда, когда тип группы контейнеров — GAME_SERVER . Вы можете передавать определения контейнеров в виде файла JSON.

ContainerName -> (строка)

Строка, уникально идентифицирующая определение контейнера в группе контейнеров.

DependsOn -> (список)

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

Вы можете использовать зависимости для установления последовательности запуска/остановки в группе контейнеров. Например, вы можете указать, что ContainerB имеет START зависимость от ContainerA . Эта зависимость означает, что ContainerB не может запуститься, пока ContainerA не запустится. Эта зависимость инвертируется при остановке, что означает, что ContainerB должен завершить свою работу перед тем, как ContainerA сможет завершить свою работу.

(структура)

Зависимость контейнера от другого контейнера в той же группе контейнеров. Зависимость влияет на то, как зависимый контейнер может запускаться или останавливаться на основе состояния другого контейнера.

Например, ContainerA настроен со следующей зависимостью: START зависимость от ContainerB . Это означает, что ContainerA не может запуститься, пока ContainerB не запустится. Это также означает, что ContainerA должен завершить свою работу перед тем, как ContainerB сможет завершить свою работу.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Дескриптивная метка для определения контейнера, от которого зависит данный контейнер.

Condition -> (строка)

Условие, которому должен соответствовать контейнер-зависимость, прежде чем зависимый контейнер сможет запуститься. Допустимые условия включают:

  • START - контейнер-зависимость должен быть запущен.
  • COMPLETE - контейнер-зависимость выполнил свою работу (завершил работу).
  • SUCCESS - контейнер-зависимость выполнил свою работу и завершил работу со статусом 0.
  • HEALTHY - контейнер-зависимость прошел проверку работоспособности Docker.

MountPoints -> (список)

Точка монтирования, которая связывает путь внутри контейнера с файлом или директорией на хост-системе и позволяет ему получить доступ к файлу или директории.

(структура)

Точка монтирования, которая связывает контейнер с файлом или директорией на хост-системе.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или директории.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если этот параметр не задан, используется путь instance.

AccessLevel -> (строка)

Тип доступа для контейнера.

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в Amazon Elastic Container Service API Reference.

(структура)

Переменная среды для установки внутри контейнера в виде пары ключ-значение.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

ImageUri -> (строка)

Расположение образа контейнера для развертывания в флот контейнеров. Предоставьте образ из общедоступного или частного репозитория Amazon Elastic Container Registry. Репозиторий должен находиться в той же учетной записи AWS и регионе, где вы создаете определение группы контейнеров. Ограничения по размеру образа см. в Amazon GameLift endpoints and quotas. Вы можете использовать любой из следующих форматов URI образа:

  • Только идентификатор образа: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
  • Идентификатор образа и дайджест: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
  • Идентификатор образа и тег: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]

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

Набор портов, которые Amazon GameLift может назначить процессам в контейнере. Процессам необходимо назначить порт контейнера для приема входящих соединений. Например, процессу сервера игр требуется порт контейнера, чтобы клиенты игр могли к нему подключиться. К портам контейнеров напрямую не осуществляется доступ извне. Вместо этого Amazon GameLift отображает порты контейнеров на внешние доступные порты подключения (см. свойство флота контейнеров ConnectionPortRange).

ContainerPortRanges -> (список)

Набор одного или нескольких диапазонов номеров портов контейнера. Диапазоны не должны пересекаться.

(структура)

Набор одного или нескольких номеров портов, которые можно открыть в контейнере.

Часть от: ContainerPortConfiguration

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

Начальное значение для диапазона допустимых номеров портов.

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

Конечное значение для диапазона допустимых номеров портов. Номера портов включают концы диапазона. Это значение должно быть равно или больше FromPort.

Protocol -> (строка)

Сетевой протокол, поддерживаемый этими портами.

ServerSdkVersion -> (строка)

Версия Amazon GameLift серверного SDK, с которой интегрирован сервер игр. Только серверы игр, использующие версию 5.2.0 или выше, совместимы с флотами контейнеров.

Синтаксис JSON:

{
  "ContainerName": "string",
  "DependsOn": [
    {
      "ContainerName": "string",
      "Condition": "START"|"COMPLETE"|"SUCCESS"|"HEALTHY"
    }
    ...
  ],
  "MountPoints": [
    {
      "InstancePath": "string",
      "ContainerPath": "string",
      "AccessLevel": "READ_ONLY"|"READ_AND_WRITE"
    }
    ...
  ],
  "EnvironmentOverride": [
    {
      "Name": "string",
      "Value": "string"
    }
    ...
  ],
  "ImageUri": "string",
  "PortConfiguration": {
    "ContainerPortRanges": [
      {
        "FromPort": integer,
        "ToPort": integer,
        "Protocol": "TCP"|"UDP"
      }
      ...
    ]
  },
  "ServerSdkVersion": "string"
}

--support-container-definitions (список)

Одна или несколько определений для контейнеров поддержки в этой группе. Вы можете определить контейнер поддержки в любом типе группы контейнеров. Вы можете передать определения контейнеров в файле JSON.

(структура)

Описывает контейнер поддержки в группе контейнеров. Вы можете определить контейнер поддержки как в группе контейнеров сервера игры, так и в группе контейнеров на экземпляр. Контейнеры поддержки не запускают процессы сервера игры.

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

Использовать с: CreateContainerGroupDefinition , UpdateContainerGroupDefinition

ContainerName -> (строка)

Строка, уникально идентифицирующая определение контейнера внутри группы контейнеров.

DependsOn -> (список)

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

.

Вы можете использовать зависимости для определения последовательности запуска/остановки в группе контейнеров. Например, вы можете указать, что ContainerB имеет START зависимость от ContainerA. Эта зависимость означает, что ContainerB не может быть запущен до тех пор, пока не будет запущен ContainerA. Эта зависимость обратная при остановке, что означает, что ContainerB должен быть остановлен перед тем, как ContainerA сможет быть остановлен.

(структура)

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

Например, ContainerA сконфигурирован с такой зависимостью: START зависимость от ContainerB. Это означает, что ContainerA не может быть запущен, пока не будет запущен ContainerB. Это также означает, что ContainerA должен быть остановлен перед ContainerB.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Дескриптивный ярлык для определения контейнера, от которого зависит этот контейнер.

Condition -> (строка)

Условие, которое зависимый контейнер должен выполнить, прежде чем зависимый контейнер сможет быть запущен. Допустимые условия включают:

  • START - Зависимый контейнер должен быть запущен.
  • COMPLETE - Зависимый контейнер завершен (выход). Используйте это условие для некритичных контейнеров, таких как контейнеры, которые выполняют скрипт и затем выходят. Зависимый контейнер не может быть критическим контейнером.
  • SUCCESS - Зависимый контейнер завершен и вышел с нулевым статусом. Зависимый контейнер не может быть критическим контейнером.
  • HEALTHY - Зависимый контейнер прошёл проверку работоспособности Docker. Используйте это условие для зависимых контейнеров, у которых настроены проверки работоспособности. Это условие проверяется только при запуске группы контейнеров.

MountPoints -> (список)

Точка монтирования, которая связывает путь внутри контейнера с файлом или директорией на хост-системе и позволяет получить к нему доступ.

(структура)

Точка монтирования, которая связывает контейнер с файлом или директорией на хост-системе.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или директории.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если это свойство не установлено, используется путь instance.

AccessLevel -> (строка)

Тип доступа для контейнера.

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в справочнике Amazon Elastic Container Service API.

(структура)

Переменная среды для установки внутри контейнера в виде пары ключ-значение.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

Essential -> (булево)

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

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

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

Command -> (список)

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

(строка)

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

Период времени (в секундах) между каждой проверкой работоспособности.

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

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

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

Необязательный период ожидания (в секундах), чтобы дать контейнеру время для инициализации, прежде чем первая неудачная проверка работоспособности будет учтена в счёт количества повторов.

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

Период времени (в секундах) ожидания успешного прохождения проверки работоспособности перед подсчётом неудачной проверки работоспособности.

ImageUri -> (строка)

Расположение образа контейнера для развертывания в группе контейнеров. Укажите образ в общедоступном или закрытом репозитории Amazon Elastic Container Registry. Репозиторий должен находиться в той же учётной записи Amazon Web Services и регионе Amazon Web Services, где вы создаёте определение группы контейнеров. Для ограничений по размеру образа см. Amazon GameLift endpoints and quotas. Вы можете использовать любой из следующих форматов URI образа:

  • Только идентификатор образа: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
  • Идентификатор образа и дайджест: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
  • Идентификатор образа и тег: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]

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

Указанное количество памяти (в МБ) для резервирования для этого контейнера. Если вы не указываете ограничение памяти для контейнера, контейнер разделяет общее выделение памяти группы контейнеров.

Связанный тип данных: ContainerGroupDefinition TotalMemoryLimitMebibytes

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

Набор портов, которые Amazon GameLift может назначить процессам в контейнере. Любые процессы, которые принимают входящие соединения, должны быть назначены портом из этого набора. Диапазон портов контейнера должен быть достаточно широким, чтобы назначить один каждому процессу в контейнере, который нуждается в нём.

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

ContainerPortRanges -> (список)

Набор одного или нескольких диапазонов номеров портов контейнера. Диапазоны не должны пересекаться.

(структура)

Набор одного или нескольких номеров портов, которые могут быть открыты в контейнере.

Часть от: ContainerPortConfiguration

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

Начальное значение для диапазона разрешённых номеров портов.

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

Конечное значение для диапазона разрешённых номеров портов. Номера портов включительно. Это значение должно быть равно или больше FromPort.

Protocol -> (строка)

Сеть протокол, который поддерживают эти порты.

Vcpu -> (вещественное число)

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

Связанный тип данных: ContainerGroupDefinition TotalCpuLimit

Синтаксис JSON:

[
  {
    "ContainerName": "string",
    "DependsOn": [
      {
        "ContainerName": "string",
        "Condition": "START"|"COMPLETE"|"SUCCESS"|"HEALTHY"
      }
      ...
    ],
    "MountPoints": [
      {
        "InstancePath": "string",
        "ContainerPath": "string",
        "AccessLevel": "READ_ONLY"|"READ_AND_WRITE"
      }
      ...
    ],
    "EnvironmentOverride": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "Essential": true|false,
    "HealthCheck": {
      "Command": ["string", ...],
      "Interval": integer,
      "Retries": integer,
      "StartPeriod": integer,
      "Timeout": integer
    },
    "ImageUri": "string",
    "MemoryHardLimitMebibytes": integer,
    "PortConfiguration": {
      "ContainerPortRanges": [
        {
          "FromPort": integer,
          "ToPort": integer,
          "Protocol": "TCP"|"UDP"
        }
        ...
      ]
    },
    "Vcpu": double
  }
  ...
]

--total-memory-limit-mebibytes (целое число)

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

--total-vcpu-limit (вещественное число)

Максимальное количество единиц vCPU для выделения группе контейнеров (1 vCPU равен 1024 CPU units). Все контейнеры в группе делят эту память. Если вы указываете ограничения vCPU для отдельных контейнеров, общее значение должно быть равно или больше суммы ограничений CPU для всех контейнеров в группе.

--version-description (строка)

Описание этого обновления определения группы контейнеров.

--source-version-number (целое число)

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

--operating-system (строка)

Платформа, которую используют все контейнеры в группе. Контейнеры в группе должны работать на одной операционной системе.

Примечание

Amazon Linux 2 (AL2) достигнет окончания поддержки 30 июня 2025 года. Подробнее см. в Amazon Linux 2 FAQs. Для серверов игр, размещённых на AL2 и использующих версию серверного SDK 4.x для Amazon GameLift, сначала обновите сборку сервера игры до серверного SDK 5.x, а затем разверните на экземплярах AL2023. См. Миграция на версию серверного SDK 5.

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

  • AMAZON_LINUX_2023

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

Вывод

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

Свойства обновленной версии определения группы контейнеров.

ContainerGroupDefinitionArn -> (строка)

Amazon Resource Name (ARN) ресурса Amazon GameLift. Уникально идентифицирует ресурс во всех регионах Amazon Web Services. Формат arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version] .

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

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

OperatingSystem -> (строка)

Платформа, на которой работают все контейнеры в определении группы контейнеров.

Примечание

Поддержка Amazon Linux 2 (AL2) закончится 30 июня 2025 года. Подробнее см. в FAQ по Amazon Linux 2. Для игровых серверов, размещенных на AL2 и использующих версию серверного SDK 4.x для Amazon GameLift, необходимо сначала обновить сборку игрового сервера на серверный SDK 5.x, а затем развернуть на экземплярах AL2023. См. Миграцию на версию серверного SDK 5.

Name -> (строка)

Дескриптивное идентификатор определения группы контейнеров. Значение имени уникально в регионе Amazon Web Services.

ContainerGroupType -> (строка)

Тип группы контейнеров. Тип группы контейнеров определяет, как Amazon GameLift развертывает группу контейнеров на каждом экземпляре флекса.

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

Объем памяти (в Мбайт) на экземпляре флекса, выделяемый для группы контейнеров. Все контейнеры в группе совместно используют эти ресурсы.

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

TotalVcpuLimit -> (двойное число)

Количество виртуальных процессорных ядер (vCPU) на экземпляре флекса, выделяемых для группы контейнеров (1 vCPU равен 1024 процессорным единицам). Все контейнеры в группе совместно используют эти ресурсы. Можно задать предел для каждого контейнера в группе. Если индивидуальные контейнеры имеют ограничения, это общее значение должно быть равно или больше суммы ограничений для каждого контейнера в группе.

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

Определение контейнера игрового сервера в этой группе. Это свойство используется только в случае, когда тип группы контейнеров равен GAME_SERVER. Это определение контейнера указывает на образ контейнера со сборкой игрового сервера.

ContainerName -> (строка)

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

DependsOn -> (список)

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

(структура)

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

Например, ContainerA настроен со следующей зависимостью: зависимость START от ContainerB. Это означает, что ContainerA не может быть запущен, пока ContainerB не будет запущен. Это также означает, что ContainerA должен быть выключен до выключения ContainerB.

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Дескриптивный ярлык определения контейнера, от которого зависит этот контейнер.

Condition -> (строка)

Условие, которое должен выполнить зависимый контейнер, прежде чем сможет запуститься зависимый контейнер. Допустимые условия включают:

  • START - Зависимый контейнер должен быть запущен.
  • COMPLETE - Зависимый контейнер выполнил завершение (вышел).
  • SUCCESS - Зависимый контейнер выполнил завершение и вышел со статусом 0.
  • HEALTHY - Зависимый контейнер прошел проверку работоспособности Docker. Используйте это условие с зависимыми контейнерами, у которых настроены проверки работоспособности. Это условие проверяется только при запуске группы контейнеров.

MountPoints -> (список)

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

(структура)

Точка монтирования, которая связывает контейнер с файлом или каталогом на хост-системе.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или каталогу.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если это свойство не задано, используется путь instance.

AccessLevel -> (строка)

Тип доступа для контейнера.

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в Amazon Elastic Container Service API Reference.

(структура)

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

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

ImageUri -> (строка)

URI образа, который Amazon GameLift использует при развертывании этого контейнера в флексе контейнеров. Для более специфического идентификатора см. ResolvedImageDigest .

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

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

ContainerPortRanges -> (список)

Набор одного или нескольких диапазонов номеров портов контейнера. Диапазоны не должны перекрываться.

(структура)

Набор одного или нескольких номеров портов, которые можно открыть в контейнере.

Часть от: ContainerPortConfiguration

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

Начальное значение диапазона разрешенных номеров портов.

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

Конечное значение диапазона разрешенных номеров портов. Номера портов включают конечные значения. Это значение должно быть равно или больше FromPort.

Protocol -> (строка)

Сеть протокол, который поддерживают эти порты.

ResolvedImageDigest -> (строка)

Уникальный и неизменяемый идентификатор образа контейнера. Digest — это SHA 256 хэш образа контейнера.

ServerSdkVersion -> (строка)

Версия серверного SDK Amazon GameLift, с которой интегрирован игровой сервер. Только игровые серверы, использующие 5.2.0 или более поздние версии, совместимы с флексами контейнеров.

SupportContainerDefinitions -> (список)

Набор определений для контейнеров поддержки в этой группе. Определение группы контейнеров может содержать ноль определений контейнеров поддержки. Контейнер поддержки может использоваться в любом типе группы контейнеров.

(структура)

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

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

Часть от: ContainerGroupDefinition

Возвращается: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

ContainerName -> (строка)

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

DependsOn -> (список)

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

(структура)

Зависимость контейнера от другого контейнера в той же группе контейнеров. Зависимость влияет на то, как зависимый контейнер может запускаться или завершать работу в зависимости от состояния другого контейнера.

Например, ContainerA настроен со следующей зависимостью: зависимость START от ContainerB . Это означает, что ContainerA не может запуститься, пока ContainerB не запустится. Это также означает, что ContainerA должен завершиться перед ContainerB .

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

ContainerName -> (строка)

Дескриптивный ярлык для определения контейнера, от которого зависит этот контейнер.

Condition -> (строка)

Условие, которому должен соответствовать зависимый контейнер, прежде чем зависимый контейнер сможет запуститься. Допустимые условия включают:

  • START - Зависимый контейнер должен быть запущен.
  • COMPLETE - Зависимый контейнер завершил работу (выход). Используйте это условие для неважных контейнеров, таких как те, которые выполняют сценарий и затем выходят. Зависимый контейнер не может быть важным контейнером.
  • SUCCESS - Зависимый контейнер завершил работу и вышел с кодом состояния ноль. Зависимый контейнер не может быть важным контейнером.
  • HEALTHY - Зависимый контейнер прошел проверку работоспособности Docker. Используйте это условие для зависимых контейнеров, которые имеют настроенные проверки работоспособности. Это условие подтверждается только при запуске группы контейнеров.

MountPoints -> (список)

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

(структура)

Точка монтирования, которая связывает контейнер с файлом или каталогом в системе хоста.

Часть от: GameServerContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html , SupportContainerDefinition , https://docs.aws.amazon.com/gamelift/latest/apireference/API_SupportContainerDefinitionInput.html

InstancePath -> (строка)

Путь к исходному файлу или каталогу.

ContainerPath -> (строка)

Путь монтирования в контейнере. Если это свойство не установлено, используется путь экземпляра.

AccessLevel -> (строка)

Тип доступа для контейнера.

EnvironmentOverride -> (список)

Набор переменных среды, передаваемых контейнеру при запуске. См. параметр ContainerDefinition::environment в Amazon Elastic Container Service API Reference .

(структура)

Переменная среды для установки внутри контейнера в виде пары «ключ-значение».

Часть от: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

Name -> (строка)

Имя переменной среды.

Value -> (строка)

Значение переменной среды.

Essential -> (булево)

Указывает, является ли контейнер важным для группы контейнеров. Если важный контейнер завершает работу, вся группа контейнеров перезапускается.

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

Настройка для проверки работоспособности, не приносящей завершения. Контейнер поддержки автоматически перезапускается, если он перестает функционировать или если он завершает эту проверку работоспособности.

Command -> (список)

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

(строка)

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

Периодичность (в секундах) между каждой проверкой работоспособности.

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

Количество попыток повторного выполнения проверки работоспособности при сбое, прежде чем контейнер будет помечен как нерабочий. Первое выполнение команды не считается повторной попыткой.

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

Необязательный период ожидания (в секундах), чтобы дать контейнеру время для начальной загрузки, прежде чем первый сбой проверки работоспособности будет учтён в количестве попыток.

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

Период времени (в секундах) ожидания успешного завершения проверки работоспособности, прежде чем считать сбой проверки работоспособности.

ImageUri -> (строка)

URI образа, который Amazon GameLift разворачивает во флот контейнеров. Для более конкретного идентификатора см. ResolvedImageDigest .

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

Объем памяти, который Amazon GameLift предоставляет контейнеру. Если лимиты памяти не установлены для отдельного контейнера, контейнер разделяет общее выделение памяти группы контейнеров.

Связанный тип данных: ContainerGroupDefinition TotalMemoryLimitMebibytes

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

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

ContainerPortRanges -> (список)

Набор одного или нескольких диапазонов номеров портов контейнера. Диапазоны не должны пересекаться.

(структура)

Набор одного или нескольких номеров портов, которые можно открыть в контейнере.

Часть от: ContainerPortConfiguration

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

Начальное значение для диапазона разрешенных номеров портов.

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

Конечное значение для диапазона разрешенных номеров портов. Номера портов включены в диапазон. Это значение должно быть равно или больше, чем FromPort .

Protocol -> (строка)

Сеть протокол, который поддерживают эти порты.

ResolvedImageDigest -> (строка)

Уникальный и неизменяемый идентификатор образа контейнера. Хэш – SHA 256 образа манифеста контейнера.

Vcpu -> (двойное число)

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

Связанный тип данных: ContainerGroupDefinition TotalVcpuLimit

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

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

VersionDescription -> (строка)

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

Status -> (строка)

Текущее состояние ресурса определения группы контейнеров. Значения включают:

  • COPYING – Amazon GameLift в процессе создания копий всех определенных в группе образов контейнеров. В этом состоянии ресурс нельзя использовать для создания флота контейнеров.
  • READY – Amazon GameLift скопировал образы реестра для всех определенных в группе контейнеров. Вы можете использовать определение группы контейнеров в этом состоянии для создания флота контейнеров.
  • FAILED – Amazon GameLift не смог создать действительный ресурс определения группы контейнеров. Для получения более подробной информации о причинах сбоя см. StatusReason . Ресурс определения группы контейнеров в состоянии «Ошибка» будет удалён в течение нескольких минут.

StatusReason -> (строка)

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

  • Внутренняя проблема помешала Amazon GameLift создать ресурс определения группы контейнеров. Удалите поврежденный ресурс и снова вызовите CreateContainerGroupDefinition.
  • Сообщение об отказе в доступе означает, что у вас нет разрешений на доступ к образу контейнера в ECR. Для получения помощи в настройке необходимых разрешений IAM для Amazon GameLift см. примеры разрешений IAM.
  • Значение ImageUri для по крайней мере одного из контейнеров в определении группы контейнеров было недействительным или не найдено в текущей учётной записи Amazon Web Services.
  • По крайней мере один из образов контейнеров, указанных в определении группы контейнеров, превышает разрешённый размер. Для ограничений по размеру см. Amazon GameLift конечные точки и квоты.
  • По крайней мере один из образов контейнеров, указанных в определении группы контейнеров, использует операционную систему, отличную от той, что определена для группы контейнеров.

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

Spec-Zone.ru

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