Class: Aws::GameLift::Types::SupportContainerDefinition

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

Overview

Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don’t run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property [GameServerContainerDefinitionInput].

**Part of:** [ContainerGroupDefinition]

**Returned by:** [DescribeContainerGroupDefinition], [ListContainerGroupDefinitions],

UpdateContainerGroupDefinition][5

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.html [2]: docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html [3]: docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeContainerGroupDefinition.html [4]: docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitions.html [5]: docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_name ⇒ String

The container definition identifier. Container names are unique within a container group definition.

Returns:

  • (String) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#depends_on ⇒ Array<Types::ContainerDependency>

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#environment_override ⇒ Array<Types::ContainerEnvironment>

A set of environment variables that’s passed to the container on startup. See the [ContainerDefinition::environment] parameter in the *Amazon Elastic Container Service API Reference*.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#essential ⇒ Boolean

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

Returns:

  • (Boolean) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#health_check ⇒ Types::ContainerHealthCheck

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#image_uri ⇒ String

The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ‘ResolvedImageDigest`.

Returns:

  • (String) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#memory_hard_limit_mebibytes ⇒ Integer

The amount of memory that Amazon GameLift makes available to the container. If memory limits aren’t set for an individual container, the container shares the container group’s total memory allocation.

Related data type: [ContainerGroupDefinition TotalMemoryLimitMebibytes]

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html

Returns:

  • (Integer) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#mount_points ⇒ Array<Types::ContainerMountPoint>

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#port_configuration ⇒ Types::ContainerPortConfiguration

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren’t directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet’s ‘ConnectionPortRange`.

Returns:



10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#resolved_image_digest ⇒ String

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

Returns:

  • (String) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#vcpu ⇒ Float

The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: [ContainerGroupDefinition TotalVcpuLimit]

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html

Returns:

  • (Float) 


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10822

class SupportContainerDefinition < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :resolved_image_digest,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end