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.
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 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 timestamp 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.
-
#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.
-
#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. Registered instances with an agent that may be unhealthy or stopped return `false`. Only instances connected to an agent can accept placement requests.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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`.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |
#attachments ⇒ Array<Types::Attachment>
The elastic network interfaces associated with the container instance.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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 `.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |
#ec2_instance_id ⇒ String
The EC2 instance ID of the container instance.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |
#pending_tasks_count ⇒ Integer
The number of tasks on the container instance that are in the ‘PENDING` status.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |
#registered_at ⇒ Time
The Unix timestamp for when the container instance was registered.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |
#running_tasks_count ⇒ Integer
The number of tasks on the container instance that are in the ‘RUNNING` status.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) 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.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/aws-sdk-ecs/types.rb', line 1328 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, :tags) include Aws::Structure end |