Class: Aws::GameLift::Types::CreateContainerGroupDefinitionInput

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::CreateContainerGroupDefinitionInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #container_definitions ⇒ Array<Types::ContainerDefinitionInput>

  Definitions for all containers in this group.

• #name ⇒ String

  A descriptive identifier for the container group definition.

• #operating_system ⇒ String

  The platform that is used by containers in the container group definition.

• #scheduling_strategy ⇒ String

  The method for deploying the container group across fleet instances.

• #tags ⇒ Array<Types::Tag>

  A list of labels to assign to the container group definition resource.

• #total_cpu_limit ⇒ Integer

  The maximum amount of CPU units to allocate to the container group.

• #total_memory_limit ⇒ Integer

  The maximum amount of memory (in MiB) to allocate to the container group.

Instance Attribute Details

#container_definitions ⇒ Array<Types::ContainerDefinitionInput>

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the [ Container fleet design guide] for container guidelines.

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

Returns:

• (Array<Types::ContainerDefinitionInput>)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :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.

Returns:

• (String)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system ⇒ String

The platform that is used by containers in the container group definition. All 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 1797

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :tags)
  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 has one copy per fleet instance. Default value is ‘REPLICA`.

Returns:

• (String)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :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 are 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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Array<Types::Tag>)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#total_cpu_limit ⇒ Integer

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Returns:

• (Integer)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#total_memory_limit ⇒ 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 individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container’s hard memory limit.

Returns:

• (Integer)

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

class CreateContainerGroupDefinitionInput < Struct.new(
  :name,
  :scheduling_strategy,
  :total_memory_limit,
  :total_cpu_limit,
  :container_definitions,
  :operating_system,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end