Class: Aws::GameLift::Types::ContainerGroupDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-gamelift/types.rb

Overview

**This data type is used with the Amazon GameLift containers feature, which is currently in public preview.**

The properties that describe a container group resource. Container group definition properties can’t be updated. To change a property, create a new container group definition.

**Used with:** CreateContainerGroupDefinition

**Returned by:** DescribeContainerGroupDefinition, ListContainerGroupDefinitions

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_definitions ⇒ Array<Types::ContainerDefinition>

The set of container definitions that are included in the container group.

Returns:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#container_group_definition_arn ⇒ String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

  • (Time) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system ⇒ String

The platform required for all containers in the container group definition.

<note markdown=“1”> 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 Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See [ Migrate to Amazon GameLift server SDK version 5.]

</note>

[1]: aws.amazon.com/amazon-linux-2/faqs/ [2]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_strategy ⇒ String

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

  • ‘COPYING` – Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can’t be used to create a container fleet.

  • ‘READY` – Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

  • ‘FAILED` – Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, see `StatusReason`. A container group definition resource in failed status will be deleted within a few minutes.

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

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

  • An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

  • An access-denied message means that you don’t have permissions to access the container image on ECR. See [ IAM permission examples] for help setting up required IAM permissions for Amazon GameLift.

  • The ‘ImageUri` value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

  • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see [ Amazon GameLift endpoints and quotas].

  • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html [2]: docs.aws.amazon.com/general/latest/gr/gamelift.html

Returns:

  • (String) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#total_cpu_limit ⇒ Integer

The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the [Container fleet design guide].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet

Returns:

  • (Integer) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#total_memory_limit ⇒ Integer

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

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

  • Equal to or greater than the sum of all container-specific soft memory limits in the group.

  • Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the [Container fleet design guide].

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet

Returns:

  • (Integer) 


1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/aws-sdk-gamelift/types.rb', line 1177

class ContainerGroupDefinition < Struct.new(
  :container_group_definition_arn,
  :creation_time,
  :operating_system,
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end