Class: Aws::GameLift::Types::GameServerContainerDefinitionInput

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

Overview

Describes the configuration for a container that runs your game server executable. This definition includes container configuration, resources, and start instructions. Use this data type when creating or updating a game server container group definition. For properties of a deployed container, see GameServerContainerDefinition. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.

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) 


6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :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:



6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :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.

Returns:



6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :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 Servers 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]@[digest]

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

Returns:

  • (String) 


6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#linux_capabilities ⇒ Types::LinuxCapabilities

Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities.

Returns:



6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :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:



6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#port_configuration ⇒ Types::ContainerPortConfiguration

A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange).

Returns:



6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#server_sdk_version ⇒ String

The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.

Returns:

  • (String) 


6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end

#vcpu ⇒ Float

The number of vCPU units reserved for the game server container. The container can use more vCPU when it's available, up to the container group's total vCPU limit if one is set. If the container group has a total vCPU limit and the request doesn't set this value, Amazon GameLift Servers calculates the game server container's vCPU as the total vCPU limit minus the sum of the vCPU units reserved for the group's support containers.

A game server container group needs either a total vCPU limit or this value. If the container group doesn't have a total vCPU limit, the group's containers can use up to the instance's available vCPU, and Amazon GameLift Servers uses the sum of the group's container Vcpu values to calculate how many game server container groups fit on an instance.

Related data type: ContainerGroupDefinition TotalVcpuLimit

Returns:

  • (Float) 


6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6845

class GameServerContainerDefinitionInput < Struct.new(
  :container_name,
  :depends_on,
  :mount_points,
  :environment_override,
  :image_uri,
  :port_configuration,
  :server_sdk_version,
  :linux_capabilities,
  :vcpu)
  SENSITIVE = []
  include Aws::Structure
end