Class: Aws::GameLift::Types::GameServerContainerDefinition
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::GameServerContainerDefinition
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
Describes the game server container in an existing game server container group. A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.
You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerContainerDefinitionInput.
Part of: ContainerGroupDefinition
Returned by: CreateContainerGroupDefinition, DescribeContainerGroupDefinition, ListContainerGroupDefinitions, ListContainerGroupDefinitionVersions, UpdateContainerGroupDefinition
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#container_name ⇒ String
The container definition identifier.
-
#depends_on ⇒ Array<Types::ContainerDependency>
Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.
-
#environment_override ⇒ Array<Types::ContainerEnvironment>
A set of environment variables that's passed to the container on startup.
-
#image_uri ⇒ String
The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet.
-
#linux_capabilities ⇒ Types::LinuxCapabilities
Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities.
-
#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.
-
#port_configuration ⇒ Types::ContainerPortConfiguration
The set of ports that are available to bind to processes in the container.
-
#resolved_image_digest ⇒ String
A unique and immutable identifier for the container image.
-
#server_sdk_version ⇒ String
The Amazon GameLift Servers server SDK version that the game server is integrated with.
-
#vcpu ⇒ Float
The number of vCPU units reserved for the game server container.
Instance Attribute Details
#container_name ⇒ String
The container definition identifier. Container names are unique within a container group definition.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :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 startup and shutdown sequences. A container might have dependencies on multiple containers.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :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.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :vcpu) SENSITIVE = [] include Aws::Structure end |
#image_uri ⇒ String
The URI to the image that Amazon GameLift Servers uses when
deploying this container to a container fleet. For a more specific
identifier, see ResolvedImageDigest.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :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.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :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.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :vcpu) SENSITIVE = [] include Aws::Structure end |
#port_configuration ⇒ Types::ContainerPortConfiguration
The set of ports that are available to bind to processes in the
container. 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. Amazon GameLift Servers maps
these container ports to externally accessible connection ports,
which are assigned as needed from the container fleet's
ConnectionPortRange.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :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.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :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.
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :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
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 6758 class GameServerContainerDefinition < Struct.new( :container_name, :depends_on, :mount_points, :environment_override, :image_uri, :port_configuration, :resolved_image_digest, :server_sdk_version, :linux_capabilities, :vcpu) SENSITIVE = [] include Aws::Structure end |