AWS SDK Version 4 for .NET
API Reference

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.

Describes the game server container in an existing game server container group. A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.

You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.GameServerContainerDefinition

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class GameServerContainerDefinition

The GameServerContainerDefinition type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ContainerName System.String

Gets and sets the property ContainerName.

The container definition identifier. Container names are unique within a container group definition.

Public Property DependsOn System.Collections.Generic.List<Amazon.GameLift.Model.ContainerDependency>

Gets and sets the property DependsOn.

Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences. A container might have dependencies on multiple containers.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property EnvironmentOverride System.Collections.Generic.List<Amazon.GameLift.Model.ContainerEnvironment>

Gets and sets the property EnvironmentOverride.

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ImageUri System.String

Gets and sets the property ImageUri.

The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet. For a more specific identifier, see ResolvedImageDigest.

Public Property MountPoints System.Collections.Generic.List<Amazon.GameLift.Model.ContainerMountPoint>

Gets and sets the property MountPoints.

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property PortConfiguration Amazon.GameLift.Model.ContainerPortConfiguration

Gets and sets the property PortConfiguration.

The set of ports that are available to bind to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

Public Property ResolvedImageDigest System.String

Gets and sets the property ResolvedImageDigest.

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

Public Property ServerSdkVersion System.String

Gets and sets the property ServerSdkVersion.

The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer