Class: Aws::GameLift::Types::ContainerDefinition

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

Overview

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#command ⇒ Array<String>

A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#container_name ⇒ String

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

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#cpu ⇒ Integer

The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

Related data type: ContainerGroupDefinition$TotalCpuLimit

Returns:

  • (Integer) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  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:



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#entry_point ⇒ Array<String>

The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ 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.

Returns:



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  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 is restarted.

Returns:

  • (Boolean) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#health_check ⇒ Types::ContainerHealthCheck

A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

Returns:



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#image_uri ⇒ String

The URI to the image that $short; copied and deployed to a container fleet. For a more specific identifier, see ResolvedImageDigest.

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#memory_limits ⇒ Types::ContainerMemoryLimits

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$TotalMemoryLimit

Returns:



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#port_configuration ⇒ Types::ContainerPortConfiguration

Defines the ports that are available to assign 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 maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

Returns:



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#resolved_image_digest ⇒ String

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

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end

#working_directory ⇒ String

The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 700

class ContainerDefinition < Struct.new(
  :container_name,
  :image_uri,
  :resolved_image_digest,
  :memory_limits,
  :port_configuration,
  :cpu,
  :health_check,
  :command,
  :essential,
  :entry_point,
  :working_directory,
  :environment,
  :depends_on)
  SENSITIVE = []
  include Aws::Structure
end