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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::UpdateContainerGroupDefinitionInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #game_server_container_definition ⇒ Types::GameServerContainerDefinitionInput

  An updated 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.

• #source_version_number ⇒ Integer

  The container group definition version to update.

• #support_container_definitions ⇒ Array<Types::SupportContainerDefinitionInput>

  One or more definitions for support containers in this group.

• #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 this update to the container group definition.

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:

• (Types::GameServerContainerDefinitionInput)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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.

<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)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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:

• (Array<Types::SupportContainerDefinitionInput>)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  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 this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Returns:

• (Float)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ String

A description for this update to the container group definition.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 11261

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)
  SENSITIVE = []
  include Aws::Structure
end