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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ecs/types.rb

Overview

An Amazon EC2 or External instance that’s running the Amazon ECS agent and has been registered with a cluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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 resources attached to a container instance, such as an elastic network interface.
#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.
#capacity_provider_name ⇒ String

The capacity provider that’s associated with the container instance.
#container_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the container instance.
#ec2_instance_id ⇒ String

The ID of the container instance.
#health_status ⇒ Types::ContainerInstanceHealthStatus

An object representing the health status 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 timestamp for the time 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.
#remaining_resources ⇒ Array<Types::Resource>

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn’t already allocated to tasks and is therefore available for new tasks.
#running_tasks_count ⇒ Integer

The number of tasks on the container instance that have a desired status (‘desiredStatus`) of `RUNNING`.
#status ⇒ String

The status of the container instance.
#status_reason ⇒ String

The reason that the container instance reached its current status.
#tags ⇒ Array<Types::Tag>

The metadata that you apply to the container instance to help you categorize and organize them.
#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. An instance with an agent that may be unhealthy or stopped return `false`. Only instances connected to an agent can accept task placement requests.

Returns:

(Boolean)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#agent_update_status ⇒ `String`

The status of the most recent agent update. If an update wasn’t ever requested, this value is ‘NULL`.

Returns:

(String)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#attachments ⇒ `Array<Types::Attachment>`

The resources attached to a container instance, such as an elastic network interface.

Returns:

(Array<Types::Attachment>)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  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][1: operation.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAttributes.html

Returns:

(Array<Types::Attribute>)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_provider_name ⇒ `String`

The capacity provider that’s associated with the container instance.

Returns:

(String)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#container_instance_arn ⇒ `String`

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see [Amazon Resource Name (ARN)] in the *Amazon ECS Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids

Returns:

(String)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_id ⇒ `String`

The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.

Returns:

(String)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#health_status ⇒ `Types::ContainerInstanceHealthStatus`

An object representing the health status of the container instance.

Returns:

(Types::ContainerInstanceHealthStatus)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  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 2116

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#registered_at ⇒ `Time`

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

Returns:

(Time)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  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 2116

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#remaining_resources ⇒ `Array<Types::Resource>`

For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn’t already 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’s not specified here is available for new tasks.

Returns:

(Array<Types::Resource>)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#running_tasks_count ⇒ `Integer`

The number of tasks on the container instance that have a desired status (‘desiredStatus`) of `RUNNING`.

Returns:

(Integer)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the container instance. The valid values are ‘REGISTERING`, `REGISTRATION_FAILED`, `ACTIVE`, `INACTIVE`, `DEREGISTERING`, or `DRAINING`.

If your account has opted in to the ‘awsvpcTrunking` account setting, then any newly registered container instance will transition to a `REGISTERING` status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a `REGISTRATION_FAILED` status. You can describe the container instance and see the reason for failure in the `statusReason` parameter. Once the container instance is terminated, the instance transitions to a `DEREGISTERING` status while the trunk elastic network interface is deprovisioned. The instance then transitions to an `INACTIVE` status.

The ‘ACTIVE` status indicates that the container instance can accept tasks. The `DRAINING` indicates that new tasks aren’t 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][1: 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 2116

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ `String`

The reason that the container instance reached its current status.

Returns:

(String)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use ‘aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

(Array<Types::Tag>)

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

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  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’re 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 2116

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  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 2116

class ContainerInstance < Struct.new(
  :container_instance_arn,
  :ec2_instance_id,
  :capacity_provider_name,
  :version,
  :version_info,
  :remaining_resources,
  :registered_resources,
  :status,
  :status_reason,
  :agent_connected,
  :running_tasks_count,
  :pending_tasks_count,
  :agent_update_status,
  :attributes,
  :registered_at,
  :attachments,
  :tags,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#agent_connected ⇒ Boolean

#agent_update_status ⇒ String

#attachments ⇒ Array<Types::Attachment>

#attributes ⇒ Array<Types::Attribute>

#capacity_provider_name ⇒ String

#container_instance_arn ⇒ String

#ec2_instance_id ⇒ String

#health_status ⇒ Types::ContainerInstanceHealthStatus

#pending_tasks_count ⇒ Integer

#registered_at ⇒ Time

#registered_resources ⇒ Array<Types::Resource>

#remaining_resources ⇒ Array<Types::Resource>

#running_tasks_count ⇒ Integer

#status ⇒ String

#status_reason ⇒ String

#tags ⇒ Array<Types::Tag>

#version ⇒ Integer

#version_info ⇒ Types::VersionInfo

#agent_connected ⇒ `Boolean`

#agent_update_status ⇒ `String`

#attachments ⇒ `Array<Types::Attachment>`

#attributes ⇒ `Array<Types::Attribute>`

#capacity_provider_name ⇒ `String`

#container_instance_arn ⇒ `String`

#ec2_instance_id ⇒ `String`

#health_status ⇒ `Types::ContainerInstanceHealthStatus`

#pending_tasks_count ⇒ `Integer`

#registered_at ⇒ `Time`

#registered_resources ⇒ `Array<Types::Resource>`

#remaining_resources ⇒ `Array<Types::Resource>`

#running_tasks_count ⇒ `Integer`

#status ⇒ `String`

#status_reason ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#version ⇒ `Integer`

#version_info ⇒ `Types::VersionInfo`