AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::Container

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

Overview

A Docker container that is part of a task.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_arnString

The Amazon Resource Name (ARN) of the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#cpuString

The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#exit_codeInteger

The exit code returned from the container.

Returns:

  • (Integer)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#gpu_idsArray<String>

The IDs of each GPU assigned to the container.

Returns:

  • (Array<String>)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#health_statusString

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#imageString

The image used for the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#image_digestString

The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#last_statusString

The last known status of the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#memoryString

The hard limit (in MiB) of memory set for the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#memory_reservationString

The soft limit (in MiB) of memory set for the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#network_bindingsArray<Types::NetworkBinding>

The network bindings associated with the container.

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#network_interfacesArray<Types::NetworkInterface>

The network interfaces associated with the container.

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#reasonString

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_idString

The ID of the Docker container.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

The ARN of the task.

Returns:

  • (String)


738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 738

class Container < Struct.new(
  :container_arn,
  :task_arn,
  :name,
  :image,
  :image_digest,
  :runtime_id,
  :last_status,
  :exit_code,
  :reason,
  :network_bindings,
  :network_interfaces,
  :health_status,
  :cpu,
  :memory,
  :memory_reservation,
  :gpu_ids)
  SENSITIVE = []
  include Aws::Structure
end