AWS SDK Version 3 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 a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.SupportContainerDefinition

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

Syntax

C#
public class SupportContainerDefinition

The SupportContainerDefinition 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 its startup and shutdown sequences. A container might have dependencies on multiple containers.

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.

Public Property Essential System.Boolean

Gets and sets the property Essential.

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

Public Property HealthCheck Amazon.GameLift.Model.ContainerHealthCheck

Gets and sets the property HealthCheck.

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

Public Property ImageUri System.String

Gets and sets the property ImageUri.

The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

Public Property MemoryHardLimitMebibytes System.Int32

Gets and sets the property MemoryHardLimitMebibytes.

The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes

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.

Public Property PortConfiguration Amazon.GameLift.Model.ContainerPortConfiguration

Gets and sets the property PortConfiguration.

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift 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 Vcpu System.Double

Gets and sets the property Vcpu.

The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

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