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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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) 


6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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



6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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



6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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


6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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



6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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

#port_configuration ⇒ Types::ContainerPortConfiguration

A set of ports that Amazon GameLift can assign to processes in the container. Processes, must be assigned a container port to accept inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren’t directly accessed by inbound traffic. Instead, Amazon GameLift maps container ports to externally accessible connection ports (see the container fleet property ‘ConnectionPortRange`).

Returns:



6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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

#server_sdk_version ⇒ String

The Amazon GameLift 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) 


6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/aws-sdk-gamelift/types.rb', line 6127

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