Class: Aws::ECS::Types::ContainerInstance

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ContainerInstance

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #agent_connected ⇒ Boolean

  This parameter returns ‘true` if the agent is connected to Amazon ECS.

• #agent_update_status ⇒ String

  The status of the most recent agent update.

• #attachments ⇒ Array<Types::Attachment>

  The Elastic Network Interfaces associated with the container instance.

• #attributes ⇒ Array<Types::Attribute>

  The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

• #container_instance_arn ⇒ String

  The Amazon Resource Name (ARN) of the container instance.

• #ec2_instance_id ⇒ String

  The EC2 instance ID of the container instance.

• #pending_tasks_count ⇒ Integer

  The number of tasks on the container instance that are in the ‘PENDING` status.

• #registered_at ⇒ Time

  The Unix time stamp for when the container instance was registered.

• #registered_resources ⇒ Array<Types::Resource>

  For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to tasks.

• #remaining_resources ⇒ Array<Types::Resource>

  For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks.

• #running_tasks_count ⇒ Integer

  The number of tasks on the container instance that are in the ‘RUNNING` status.

• #status ⇒ String

  The status of the container instance.

• #version ⇒ Integer

  The version counter for the container instance.

• #version_info ⇒ Types::VersionInfo

  The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Instance Attribute Details

#agent_connected ⇒ Boolean

This parameter returns ‘true` if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return `false`. Instances without a connected agent can’t accept placement requests.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#agent_update_status ⇒ String

The status of the most recent agent update. If an update has never been requested, this value is ‘NULL`.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#attachments ⇒ Array<Types::Attachment>

The Elastic Network Interfaces associated with the container instance.

Returns:

• (Array<Types::Attachment>)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#attributes ⇒ Array<Types::Attribute>

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

Returns:

• (Array<Types::Attribute>)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#container_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the container instance. The ARN contains the ‘arn:aws:ecs` namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the `container-instance` namespace, and then the container instance ID. For example, `arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID `.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#ec2_instance_id ⇒ String

The EC2 instance ID of the container instance.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#pending_tasks_count ⇒ Integer

The number of tasks on the container instance that are in the ‘PENDING` status.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#registered_at ⇒ Time

The Unix time stamp for when the container instance was registered.

Returns:

• (Time)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#registered_resources ⇒ Array<Types::Resource>

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

Returns:

• (Array<Types::Resource>)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#remaining_resources ⇒ Array<Types::Resource>

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the ‘host` or `bridge` network mode). Any port that is not specified here is available for new tasks.

Returns:

• (Array<Types::Resource>)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#running_tasks_count ⇒ Integer

The number of tasks on the container instance that are in the ‘RUNNING` status.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#status ⇒ String

The status of the container instance. The valid values are ‘ACTIVE`, `INACTIVE`, or `DRAINING`. `ACTIVE` indicates that the container instance can accept tasks. `DRAINING` indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see [Container Instance Draining] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#version ⇒ Integer

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the ‘detail` object) to verify that the version in your event stream is current.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end

#version_info ⇒ Types::VersionInfo

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Returns:

• (Types::VersionInfo)

# File 'lib/aws-sdk-ecs/types.rb', line 1187

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments)
  include Aws::Structure
end