Container for the parameters to the CreateContainerGroupDefinition operation. This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Creates a ContainerGroupDefinition resource that describes a set of containers
for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift
container group is similar to a container "task" and "pod". Each container group can
have one or more containers.
Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.
You can create two types of container groups, based on scheduling strategy:
-
A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.
-
A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.
To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.
This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift for help setting the appropriate permissions.
If successful, this operation creates a new ContainerGroupDefinition resource
with an ARN value assigned. You can't change the properties of a container group definition.
Instead, create a new one.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.CreateContainerGroupDefinitionRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class CreateContainerGroupDefinitionRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The CreateContainerGroupDefinitionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateContainerGroupDefinitionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ContainerDefinitions | System.Collections.Generic.List<Amazon.GameLift.Model.ContainerDefinitionInput> |
Gets and sets the property ContainerDefinitions. Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines. |
|
|
Name | System.String |
Gets and sets the property Name. A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region. |
|
|
OperatingSystem | Amazon.GameLift.ContainerOperatingSystem |
Gets and sets the property OperatingSystem. The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system. |
|
|
SchedulingStrategy | Amazon.GameLift.ContainerSchedulingStrategy |
Gets and sets the property SchedulingStrategy.
The method for deploying the container group across fleet instances. A replica container
group might have multiple copies on each fleet instance. A daemon container group
has one copy per fleet instance. Default value is |
|
|
Tags | System.Collections.Generic.List<Amazon.GameLift.Model.Tag> |
Gets and sets the property Tags. A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. |
|
|
TotalCpuLimit | System.Int32 |
Gets and sets the property TotalCpuLimit. The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group. |
|
|
TotalMemoryLimit | System.Int32 |
Gets and sets the property TotalMemoryLimit. 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 individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5