# ecs-info

**Repository Path**: mirrors_mapbox/ecs-info

## Basic Information

- **Project Name**: ecs-info
- **Description**: Library for reading the state of an AWS::ECS::Cluster
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ecs-info

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

#### work in progress

```js
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](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeClusters-property) 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](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeTasks-property) 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](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeTaskDefinition-property)

A `Service` is the [response from an ecs.describeServices request](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeServices-property) with additional properties:
- **tasks** 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](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeServices-property)) is augmented to include:
  - **targetHealthDescriptions** [response from elbv2.describeTargetHealth request](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ELBv2.html#describeTargetHealth-property) for the case of an application load balancer
  - **instanceStates** [response from an elb.describeInstanceHealth request](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ELB.html#describeInstanceHealth-property) for the case of a classic load balancer

An `Instance` is the [response from an ecs.describeContainerInstances request](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ECS.html#describeContainerInstances-property) with additional properties:
- **ec2Info** the [response from an ec2.describeInstances request](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/EC2.html#describeInstances-property)
- **tasks** an array of tasks running on the instance

Furthermore, 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:

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