Class CfnContainerGroupDefinitionProps
Properties for defining a CfnContainerGroupDefinition.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContainerGroupDefinitionProps : ICfnContainerGroupDefinitionPropsSyntax (vb)
Public Class CfnContainerGroupDefinitionProps Implements ICfnContainerGroupDefinitionPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnContainerGroupDefinitionProps = new CfnContainerGroupDefinitionProps {
Name = "name",
OperatingSystem = "operatingSystem",
TotalMemoryLimitMebibytes = 123,
TotalVcpuLimit = 123,
// the properties below are optional
ContainerGroupType = "containerGroupType",
GameServerContainerDefinition = new GameServerContainerDefinitionProperty {
ContainerName = "containerName",
ImageUri = "imageUri",
ServerSdkVersion = "serverSdkVersion",
// the properties below are optional
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
Name = "name",
Value = "value"
} },
MountPoints = new [] { new ContainerMountPointProperty {
InstancePath = "instancePath",
// the properties below are optional
AccessLevel = "accessLevel",
ContainerPath = "containerPath"
} },
PortConfiguration = new PortConfigurationProperty {
ContainerPortRanges = new [] { new ContainerPortRangeProperty {
FromPort = 123,
Protocol = "protocol",
ToPort = 123
} }
},
ResolvedImageDigest = "resolvedImageDigest"
},
SourceVersionNumber = 123,
SupportContainerDefinitions = new [] { new SupportContainerDefinitionProperty {
ContainerName = "containerName",
ImageUri = "imageUri",
// the properties below are optional
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
Name = "name",
Value = "value"
} },
Essential = false,
HealthCheck = new ContainerHealthCheckProperty {
Command = new [] { "command" },
// the properties below are optional
Interval = 123,
Retries = 123,
StartPeriod = 123,
Timeout = 123
},
MemoryHardLimitMebibytes = 123,
MountPoints = new [] { new ContainerMountPointProperty {
InstancePath = "instancePath",
// the properties below are optional
AccessLevel = "accessLevel",
ContainerPath = "containerPath"
} },
PortConfiguration = new PortConfigurationProperty {
ContainerPortRanges = new [] { new ContainerPortRangeProperty {
FromPort = 123,
Protocol = "protocol",
ToPort = 123
} }
},
ResolvedImageDigest = "resolvedImageDigest",
Vcpu = 123
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionDescription = "versionDescription"
};Synopsis
Constructors
| CfnContainerGroupDefinitionProps() | Properties for defining a |
Properties
| ContainerGroupType | The type of container group. |
| GameServerContainerDefinition | The definition for the game server container in this group. |
| Name | A descriptive identifier for the container group definition. |
| OperatingSystem | The platform that all containers in the container group definition run on. |
| SourceVersionNumber | A specific ContainerGroupDefinition version to be updated. |
| SupportContainerDefinitions | The set of definitions for support containers in this group. |
| Tags | An array of key-value pairs to apply to this resource. |
| TotalMemoryLimitMebibytes | The amount of memory (in MiB) on a fleet instance to allocate for the container group. |
| TotalVcpuLimit | The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). |
| VersionDescription | An optional description that was provided for a container group definition update. |
Constructors
CfnContainerGroupDefinitionProps()
Properties for defining a CfnContainerGroupDefinition.
public CfnContainerGroupDefinitionProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnContainerGroupDefinitionProps = new CfnContainerGroupDefinitionProps {
Name = "name",
OperatingSystem = "operatingSystem",
TotalMemoryLimitMebibytes = 123,
TotalVcpuLimit = 123,
// the properties below are optional
ContainerGroupType = "containerGroupType",
GameServerContainerDefinition = new GameServerContainerDefinitionProperty {
ContainerName = "containerName",
ImageUri = "imageUri",
ServerSdkVersion = "serverSdkVersion",
// the properties below are optional
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
Name = "name",
Value = "value"
} },
MountPoints = new [] { new ContainerMountPointProperty {
InstancePath = "instancePath",
// the properties below are optional
AccessLevel = "accessLevel",
ContainerPath = "containerPath"
} },
PortConfiguration = new PortConfigurationProperty {
ContainerPortRanges = new [] { new ContainerPortRangeProperty {
FromPort = 123,
Protocol = "protocol",
ToPort = 123
} }
},
ResolvedImageDigest = "resolvedImageDigest"
},
SourceVersionNumber = 123,
SupportContainerDefinitions = new [] { new SupportContainerDefinitionProperty {
ContainerName = "containerName",
ImageUri = "imageUri",
// the properties below are optional
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
Name = "name",
Value = "value"
} },
Essential = false,
HealthCheck = new ContainerHealthCheckProperty {
Command = new [] { "command" },
// the properties below are optional
Interval = 123,
Retries = 123,
StartPeriod = 123,
Timeout = 123
},
MemoryHardLimitMebibytes = 123,
MountPoints = new [] { new ContainerMountPointProperty {
InstancePath = "instancePath",
// the properties below are optional
AccessLevel = "accessLevel",
ContainerPath = "containerPath"
} },
PortConfiguration = new PortConfigurationProperty {
ContainerPortRanges = new [] { new ContainerPortRangeProperty {
FromPort = 123,
Protocol = "protocol",
ToPort = 123
} }
},
ResolvedImageDigest = "resolvedImageDigest",
Vcpu = 123
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionDescription = "versionDescription"
};Properties
ContainerGroupType
The type of container group.
public string? ContainerGroupType { get; set; }Property Value
Remarks
Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
GameServerContainerDefinition
The definition for the game server container in this group.
public object? GameServerContainerDefinition { get; set; }Property Value
Remarks
This property is used only when the container group type is GAME_SERVER . This container definition specifies a container image with the game server build.
Name
A descriptive identifier for the container group definition.
public string Name { get; set; }Property Value
Remarks
The name value is unique in an AWS Region.
OperatingSystem
The platform that all containers in the container group definition run on.
public string OperatingSystem { get; set; }Property Value
Remarks
Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the <a href="https://docs.aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a> . 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 <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html">Migrate to server SDK version 5.</a>
SourceVersionNumber
A specific ContainerGroupDefinition version to be updated.
public double? SourceVersionNumber { get; set; }Property Value
Remarks
SupportContainerDefinitions
The set of definitions for support containers in this group.
public object? SupportContainerDefinitions { get; set; }Property Value
Remarks
A container group definition might have zero support container definitions. Support container can be used in any type of container group.
Tags
An array of key-value pairs to apply to this resource.
public ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
TotalMemoryLimitMebibytes
The amount of memory (in MiB) on a fleet instance to allocate for the container group.
public double TotalMemoryLimitMebibytes { get; set; }Property Value
Remarks
All containers in the group share these resources.
You can set a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.
TotalVcpuLimit
The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).
public double TotalVcpuLimit { get; set; }Property Value
Remarks
All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.
VersionDescription
An optional description that was provided for a container group definition update.
public string? VersionDescription { get; set; }Property Value
Remarks
Each version can have a unique description.