Values.CreateContainerGroupDefinitionInputSourceThis API works with the following fleet types: Container Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet. A container group definition determines how Amazon GameLift Servers deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition. There are two types of container groups: A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types: Game server container. This container runs your game server. You can define one game server container in a game server container group. Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group. When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers. On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together. A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers. This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift Servers for help setting the appropriate permissions. Request options Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later. Create a game server container group definition. Provide the following required parameter values: Name ContainerGroupType (GAME_SERVER) OperatingSystem (omit to use default value) TotalMemoryLimitMebibytes (omit to use default value) TotalVcpuLimit (omit to use default value) At least one GameServerContainerDefinition ContainerName ImageUrl PortConfiguration ServerSdkVersion (omit to use default value) Create a per-instance container group definition. Provide the following required parameter values: Name ContainerGroupType (PER_INSTANCE) OperatingSystem (omit to use default value) TotalMemoryLimitMebibytes (omit to use default value) TotalVcpuLimit (omit to use default value) At least one SupportContainerDefinition ContainerName ImageUrl Results If successful, this request creates a ContainerGroupDefinition resource and assigns a unique ARN value. You can update most properties of a container group definition by calling UpdateContainerGroupDefinition, and optionally save the update as a new version.
type nonrec t = {name : ContainerGroupDefinitionName.t;A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
*)containerGroupType : ContainerGroupType.t option;The type of container group being defined. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance. Default value: GAME_SERVER
*)totalMemoryLimitMebibytes : ContainerTotalMemoryLimit.t;The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for an individual container, the total value must be greater than any individual container's memory limit. Default value: 1024
*)totalVcpuLimit : ContainerTotalVcpuLimit.t;The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group. Default value: 1
*)gameServerContainerDefinition : GameServerContainerDefinitionInput.t option;The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
*)supportContainerDefinitions : SupportContainerDefinitionInputList.t option;One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
*)operatingSystem : ContainerOperatingSystem.t;The platform that all containers in the group use. Containers in a group must run on the same operating system. Default value: AMAZON_LINUX_2023 Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.
*)versionDescription : NonZeroAndMaxString.t option;A description for the initial version of this container group definition.
*)}val make :
?containerGroupType:??? ->
?gameServerContainerDefinition:??? ->
?supportContainerDefinitions:??? ->
?versionDescription:??? ->
?tags:??? ->
name:ContainerGroupDefinitionName.t ->
totalMemoryLimitMebibytes:ContainerTotalMemoryLimit.t ->
totalVcpuLimit:ContainerTotalVcpuLimit.t ->
operatingSystem:ContainerOperatingSystem.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Double of ContainerTotalVcpuLimit.t
| `Enum of string
| `Integer of ContainerTotalMemoryLimit.t
| `List of
[> `Structure of
(string
* [> `Boolean of BooleanModel.t
| `Double of ContainerVcpu.t
| `Integer of ContainerMemoryLimit.t
| `List of
[> `Structure of
(string
* [> `Enum of string
| `String of NonZeroAnd128MaxAsciiString.t ])
list ]
list
| `String of NonZeroAnd128MaxAsciiString.t
| `Structure of
(string
* [> `Integer of ContainerHealthCheckInterval.t
| `List of
[> `String of NonZeroAnd255MaxString.t
| `Structure of
(string
* [> `Enum of string | `Integer of PortNumber.t ])
list ]
list ])
list ])
list ]
list
| `String of ContainerGroupDefinitionName.t
| `Structure of
(string
* [> `List of
[> `Structure of
(string
* [> `Enum of string
| `String of NonZeroAnd128MaxAsciiString.t ])
list ]
list
| `String of NonZeroAnd128MaxAsciiString.t
| `Structure of
(string
* [> `List of
[> `Structure of
(string
* [> `Enum of string
| `Integer of PortNumber.t ])
list ]
list ])
list ])
list ])
list ]