Class: Aws::GameLift::Types::SupportContainerDefinitionInput

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

Overview

Describes a support container in a container group. You can define a support container in either a game server container group or a per-instance container group. Support containers don’t run game server processes.

This definition includes container configuration, resources, and start instructions. Use this data type when creating or updating a container group definition. For properties of a deployed support container, see SupportContainerDefinition.

Use with: CreateContainerGroupDefinition, UpdateContainerGroupDefinition

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_name ⇒ String

A string that uniquely identifies the container definition within a container group.

Returns:

  • (String) 


10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#depends_on ⇒ Array<Types::ContainerDependency>

Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

.

You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a ‘START` dependency on ContainerA. This dependency means that ContainerB can’t start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

Returns:



10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#environment_override ⇒ Array<Types::ContainerEnvironment>

A set of environment variables to pass 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:



10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#essential ⇒ Boolean

Flags the container as vital for the container group to function properly. If an essential container fails, the entire container group restarts. At least one support container in a per-instance container group must be essential. When flagging a container as essential, also configure a health check so that the container can signal that it’s healthy.

Returns:

  • (Boolean) 


10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#health_check ⇒ Types::ContainerHealthCheck

Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. With a health check, you can define additional reasons to flag a container as unhealthy and restart it. If an essential container fails a health check, the entire container group restarts.

Returns:



10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#image_uri ⇒ String

The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you’re creating the container group definition. For limits on image size, see [Amazon GameLift endpoints and quotas]. You can use any of the following image URI formats:

  • Image ID only: ‘[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]`

  • Image ID and digest: ‘[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@`

  • Image ID and tag: ‘[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:`

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

Returns:

  • (String) 


10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#memory_hard_limit_mebibytes ⇒ Integer

A specified amount of memory (in MiB) to reserve for this container. If you don’t specify a container-specific memory limit, the container shares the container group’s total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes“

Returns:

  • (Integer) 


10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

class SupportContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :essential,
  :health_check,
  :image_uri,
  :memory_hard_limit_mebibytes,
  :port_configuration,
  :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:



10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#port_configuration ⇒ Types::ContainerPortConfiguration

A set of ports that Amazon GameLift can assign to processes in the container. Any processes that accept inbound traffic connections must be assigned a port from this set. The container port range must be large enough to assign one to each process in the container that needs one.

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:



10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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

#vcpu ⇒ Float

The number of vCPU units to reserve for this container. The container can use more resources when needed, if available. If you don’t reserve CPU units for this container, it shares the container group’s total vCPU limit.

Related data type: ContainerGroupDefinition TotalCpuLimit

Returns:

  • (Float) 


10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
 
# File 'lib/aws-sdk-gamelift/types.rb', line 10722

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