Builder

class Builder

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

An object representing the health status of the container instance.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The reason that the container instance reached its current status.

Link copied to clipboard
var 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. You define both.

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard