Class: Aws::GameLift::Types::UpdateContainerGroupDefinitionInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#game_server_container_definition ⇒ Types::GameServerContainerDefinitionInput

An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. You can pass in your container definitions as a JSON file.

Returns:



12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  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.

Returns:

  • (String) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  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.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. 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.

Returns:

  • (String) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#remove_attributes ⇒ Array<String>

If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.

Returns:

  • (Array<String>) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#source_version_number ⇒ Integer

The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.

Returns:

  • (Integer) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#support_container_definitions ⇒ Array<Types::SupportContainerDefinitionInput>

One or more definitions 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.

Returns:



12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  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.

Returns:

  • (Integer) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  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.

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 the container group has a total vCPU limit, Amazon GameLift Servers uses this value to calculate how many game server container groups fit on an instance. If the container group doesn't have a total vCPU limit, its 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. To remove the total vCPU limit, omit this parameter and set RemoveAttributes to TOTAL_VCPU_LIMIT.

Returns:

  • (Float) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A description for this update to the container group definition.

Returns:

  • (String) 


12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 12798

class UpdateContainerGroupDefinitionInput < Struct.new(
  :name,
  :game_server_container_definition,
  :support_container_definitions,
  :total_memory_limit_mebibytes,
  :total_vcpu_limit,
  :version_description,
  :source_version_number,
  :operating_system,
  :remove_attributes)
  SENSITIVE = []
  include Aws::Structure
end