ecs-info v0.0.7

ecs-info

Library for querying the state of an AWS::ECS::Cluster

work in progress

var ecs = require('ecs-info');
ecs.Cluster.describe('my-cluster', 'us-east-1')
  .then(clusterData => { ... });

Cluster description

The object that comes back has circular references that you can use to trace the relationships between EC2 instances, ECS services, and ECS tasks that are part of the cluster. Basically:

Cluster {
  tasks: [ ...Task {} ],
  instances: [ ...Instance {} ],
  services: [ ...Service {} ]
}

A Cluster is the response from an ecs.describeClusters request with additional properties:

• tasks an array of tasks running or stopped on the cluster
• services an array of services running on the cluster
• instances an array of instances in the cluster

A Task is the response from an ecs.describeTasks request with additional properties:

• instance the host instance
• service the service this task is a part of (or null)
• taskDefinition the response from an ecs.describeTaskDefinition request

A Service is the response from an ecs.describeServices request with additional properties:

• childTasks an array of tasks that are part of the service
• loadBalancers the array of objects describing a service's load balancers (part of the ecs.describeServices response) is augmented to include:
  • targetHealthDescriptions response from elbv2.describeTargetHealth request for the case of an application load balancer
  • instanceStates response from an elb.describeInstanceHealth request for the case of a classic load balancer

An Instance is the response from an ecs.describeContainerInstances request with additional properties:

• ec2Info the response from an ec2.describeInstances request
• tasks an array of tasks running on the instance

Futhermore, each of these classes have a set of prototype methods that they implement. These can be useful for formatting or resolving specific information about a cluster, task, service, or instance.

Additional treats

Return an array of IAM policy statements providing permission to run the API requests involved in this library:

ecs.iamPermissions('my-cluster-name');