ContainerGroupDefinition

The properties that describe a container group resource. You can update all properties of a container group definition properties. Updates to a container group definition are saved as new versions.

Used with:CreateContainerGroupDefinition

Returned by:DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version].

Link copied to clipboard

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

Link copied to clipboard

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Link copied to clipboard

The definition for the game server container in this group. 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.

Link copied to clipboard
val name: String?

A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

Link copied to clipboard

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

Link copied to clipboard

Current status of the container group definition resource. Values include:

Link copied to clipboard

Additional information about a container group definition that's in FAILED status. Possible reasons include:

Link copied to clipboard

The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.

Link copied to clipboard

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

Link copied to clipboard

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). 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.

Link copied to clipboard

An optional description that was provided for a container group definition update. Each version can have a unique description.

Link copied to clipboard

Indicates the version of a particular container group definition. This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String