ContainerInstance class

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

Constructors

ContainerInstance({bool? agentConnected, AgentUpdateStatus? agentUpdateStatus, List<Attachment>? attachments, List<Attribute>? attributes, String? capacityProviderName, String? containerInstanceArn, String? ec2InstanceId, int? pendingTasksCount, DateTime? registeredAt, List<Resource>? registeredResources, List<Resource>? remainingResources, int? runningTasksCount, String? status, String? statusReason, List<Tag>? tags, int? version, VersionInfo? versionInfo})

ContainerInstance.fromJson(Map<String, dynamic> json)

factory

Properties

agentConnected → bool?

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.

final

agentUpdateStatus → AgentUpdateStatus?

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

final

attachments → List<Attachment>?

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

final

attributes → List<Attribute>?

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

final

capacityProviderName → String?

The capacity provider associated with the container instance.

final

containerInstanceArn → 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.

final

ec2InstanceId → String?

The EC2 instance ID of the container instance.

final

hashCode → int

The hash code for this object.

no setter, inherited

pendingTasksCount → int?

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

final

registeredAt → DateTime?

The Unix timestamp for when the container instance was registered.

final

registeredResources → List<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.

final

remainingResources → List<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.

final

runningTasksCount → int?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → String?

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

final

statusReason → String?

The reason that the container instance reached its current status.

final

tags → List<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.

final

version → int?

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.

final

versionInfo → VersionInfo?

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

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited