Interface ICfnContainerGroupDefinitionProps

Properties for defining a CfnContainerGroupDefinition.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnContainerGroupDefinitionProps

Syntax (vb)

Public Interface ICfnContainerGroupDefinitionProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html

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

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.

Properties

ContainerGroupType

The type of container group.

virtual string ContainerGroupType { get; }

Property Value

System.String

Remarks

Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containergrouptype

GameServerContainerDefinition

The definition for the game server container in this group.

virtual object GameServerContainerDefinition { get; }

Property Value

System.Object

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition

Name

A descriptive identifier for the container group definition.

string Name { get; }

Property Value

System.String

Remarks

The name value is unique in an AWS Region.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name

OperatingSystem

The platform that all containers in the container group definition run on.

string OperatingSystem { get; }

Property Value

System.String

Remarks

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs . 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 Migrate to server SDK version 5.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem

SourceVersionNumber

A specific ContainerGroupDefinition version to be updated.

virtual Nullable<double> SourceVersionNumber { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-sourceversionnumber

SupportContainerDefinitions

The set of definitions for support containers in this group.

virtual object SupportContainerDefinitions { get; }

Property Value

System.Object

Remarks

A container group definition might have zero support container definitions. Support container can be used in any type of container group.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinitions

TotalMemoryLimitMebibytes

The amount of memory (in MiB) on a fleet instance to allocate for the container group.

double TotalMemoryLimitMebibytes { get; }

Property Value

System.Double

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimitmebibytes

TotalVcpuLimit

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).

double TotalVcpuLimit { get; }

Property Value

System.Double

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalvcpulimit

VersionDescription

An optional description that was provided for a container group definition update.

virtual string VersionDescription { get; }

Property Value

System.String

Remarks

Each version can have a unique description.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-versiondescription