Class: Aws::GameLift::Types::CreateContainerGroupDefinitionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::CreateContainerGroupDefinitionInput
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#container_group_type ⇒ String
The type of container group being defined.
-
#game_server_container_definition ⇒ Types::GameServerContainerDefinitionInput
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 group use.
-
#support_container_definitions ⇒ Array<Types::SupportContainerDefinitionInput>
One or more definition for support containers in this group.
-
#tags ⇒ Array<Types::Tag>
A list of labels to assign to the container group definition resource.
-
#total_memory_limit_mebibytes ⇒ Integer
The maximum amount of memory (in MiB) to allocate to the container group.
-
#total_vcpu_limit ⇒ Float
The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units).
-
#version_description ⇒ String
A description for the initial version of this container group definition.
Instance Attribute Details
#container_group_type ⇒ String
The type of container group being defined. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
Default value: GAME_SERVER
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#game_server_container_definition ⇒ Types::GameServerContainerDefinitionInput
The definition for the game server container in this group. Define a
game server container only when the container group type is
GAME_SERVER. Game server containers specify a container image with
your game server build. You can pass in your container definitions
as a JSON file.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#operating_system ⇒ String
The platform that all containers in the group use. Containers in a group must run on the same operating system.
Default value: AMAZON_LINUX_2023
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#support_container_definitions ⇒ Array<Types::SupportContainerDefinitionInput>
One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#total_memory_limit_mebibytes ⇒ Integer
The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for an individual container, the total value must be greater than any individual container's memory limit.
Default value: 1024
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#total_vcpu_limit ⇒ Float
The maximum amount of vCPU units to allocate to the container group
(1 vCPU is equal to 1024 CPU units). All containers in the group
share these resources. If you set vCPU reservations for individual
containers, the total value must be equal to or greater than the sum
of the Vcpu values for all containers in the group.
This property is required for a per-instance container group.
For a game server container group, Amazon GameLift Servers requires
either a total vCPU limit or a Vcpu value for the game server
container. If you set a total vCPU limit for a game server container
group, Amazon GameLift Servers uses this value to calculate how many
game server container groups fit on an instance. If you don't set a
total vCPU limit, the group's containers can use up to the
instance's available vCPU, and Amazon GameLift Servers uses the sum
of the containers' Vcpu values to calculate how many game server
container groups fit on an instance.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |
#version_description ⇒ String
A description for the initial version of this container group definition.
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2074 class CreateContainerGroupDefinitionInput < Struct.new( :name, :container_group_type, :total_memory_limit_mebibytes, :total_vcpu_limit, :game_server_container_definition, :support_container_definitions, :operating_system, :version_description, :tags) SENSITIVE = [] include Aws::Structure end |