Class: Aws::GameLift::Types::ContainerGroupDefinition
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::ContainerGroupDefinition
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#container_group_definition_arn ⇒ String
The Amazon Resource Name ([ARN][1]) that is assigned to an Amazon GameLift
ContainerGroupDefinition
resource. -
#container_group_type ⇒ String
The type of container group.
-
#creation_time ⇒ Time
A time stamp indicating when this data object was created.
-
#game_server_container_definition ⇒ Types::GameServerContainerDefinition
The definition for the game server container in this group.
-
#name ⇒ String
A descriptive identifier for the container group definition.
-
#operating_system ⇒ String
The platform that all containers in the container group definition run on.
-
#status ⇒ String
Current status of the container group definition resource.
-
#status_reason ⇒ String
Additional information about a container group definition that's in
FAILED
status. -
#support_container_definitions ⇒ Array<Types::SupportContainerDefinition>
The set of definitions for support containers in this group.
-
#total_memory_limit_mebibytes ⇒ Integer
The amount of memory (in MiB) on a fleet instance to allocate for the container group.
-
#total_vcpu_limit ⇒ Float
The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).
-
#version_description ⇒ String
An optional description that was provided for a container group definition update.
-
#version_number ⇒ Integer
Indicates the version of a particular container group definition.
Instance Attribute Details
#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]:[version]
.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#container_group_type ⇒ String
The type of container group. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :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"
).
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#game_server_container_definition ⇒ Types::GameServerContainerDefinition
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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#operating_system ⇒ String
The platform that all containers in the container group definition run on.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :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, seeStatusReason
. A container group definition resource in failed status will be deleted within a few minutes.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#support_container_definitions ⇒ Array<Types::SupportContainerDefinition>
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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#total_memory_limit_mebibytes ⇒ 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 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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#total_vcpu_limit ⇒ Float
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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#version_description ⇒ String
An optional description that was provided for a container group definition update. Each version can have a unique description.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |
#version_number ⇒ Integer
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.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1065 class ContainerGroupDefinition < Struct.new( :container_group_definition_arn, :creation_time, :operating_system, :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :version_number, :version_description, :status, :status_reason) SENSITIVE = [] include Aws::Structure end |