AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Creates a ContainerGroupDefinition that describes a set of containers for hosting
your game server with Amazon GameLift managed containers hosting. An Amazon GameLift
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 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 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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateContainerGroupDefinition and EndCreateContainerGroupDefinition.
Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
public virtual Task<CreateContainerGroupDefinitionResponse> CreateContainerGroupDefinitionAsync( CreateContainerGroupDefinitionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CreateContainerGroupDefinition service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ConflictException | The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. |
| InternalServiceException | The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period. |
| InvalidRequestException | One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying. |
| LimitExceededException | The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying. |
| TaggingFailedException | The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying. |
| UnauthorizedException | The client failed authentication. Clients should not retry such requests. |
| UnsupportedRegionException | The requested operation is not supported in the Region specified. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer