Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon ECS

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "Stmt1510752410000",
      "Effect": "Allow",
      "Action": [
        "ecs:Describe*",
        "ecs:List*",
        "cloudwatch:ListMetrics",
        "cloudwatch:GetMetricStatistics"
      ],
      "Resource": [
        "*"
      ]
    }
  ]
}

Connection Parameters

Name
Required?
Description

Region

Access Key ID

Required

Secret Access Key

Required

Additional Threads

The number of additional threads allowed to be utilized during collection.

Request Timeout (seconds)

The number of seconds to allow for the API to return a response.

Collect CloudWatch Metrics

CloudWatch Historic Mode

If enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Cluster

Name
Description

Active EC2 Services Count

The number of EC2 services that are running on this Cluster in an ACTIVE state.

Active Fargate Services Count

The number of Fargate services that are running on this Cluster in an ACTIVE state.

Active Services

The number of services that are running on this Cluster in an ACTIVE state.

ARN

The ARN that defines the cluster.

CPU Reservation (%)

The percentage of CPU units that are reserved by running tasks in the cluster.

CPU Utilization (%)

The percentage of CPU units that are used in the cluster.

Draining EC2 Services Count

The number of EC2 services that are running on this Cluster in a DRAINING state.

Draining Fargate Services Count

The number of Fargate services that are running on this Cluster in a DRAINING state.

Memory Reservation (%)

The percentage of memory that is reserved by running tasks in the cluster.

Memory Utilization (%)

The percentage of memory that is used in the cluster.

Name

The name of the EC2 Cluster

Pending EC2 Tasks Count

The number of EC2 tasks in this Cluster that are in the PENDING state.

Pending Fargate Tasks Count

The number of Fargate tasks in this Cluster that are in the PENDING state.

Pending Tasks Count

The number of tasks in this Cluster that are in the PENDING state.

Region

The AWS Region this object belongs to.

Registered Container Instances Count

The number of container instances registered to this Cluster.

Running EC2 Tasks Count

The number of EC2 tasks in this Cluster that are in the RUNNING state.

Running Fargate Tasks Count

The number of Fargate tasks in this Cluster that are in the RUNNING state.

Running Tasks Count

The number of tasks in this Cluster that are in the RUNNING state.

Status

The status of this Cluster.

Container Instance

Name
Description

Agent Connected

If the agent is connected to Amazon ECS.

Agent Hash

The git commit hash of the Amazon ECS container agent build.

Agent Update Status

Status of the most recent agent update.

Agent Version

The version of the Amazon ECS container agent.

ARN

The ARN of the Container Instance.

Cluster ARN

The Amazon Resource Name (ARN) of the cluster that hosts this Instance.

Docker Version

The Docker version running on the Container Instance.

EC2 Instance ID

The EC2 Instance ID of the Container Instance.

ID

The ID of the Container Instance.

Pending Tasks Count

The number of tasks on the Container Instance that are in the Pending state.

Region

The AWS Region this object belongs to.

Registered Time

The time for when the Container Instance was registered.

Running Tasks Count

The number of tasks on the Container Instance that are in the Running state.

Status

The status of the Container Instance.

Version Counter

The version counter for the Container Instance.

Service

Name
Description

ARN

The ARN that identifies the Service.

Cluster ARN

The Amazon Resource Name (ARN) of the cluster that hosts this Service.

Cluster Name

The name of the EC2 Cluster

CPU Utilization (%)

The percentage of CPU units that are used in the service.

Created Time

The time for when this Service was created.

Deployment Maximum Tasks (%)

The upper limit (as a percentage of the Service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a Service during a deployment.

Deployment Minimum Healthy Tasks (%)

The lower limit (as a percentage of the Service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a Service during a deployment.

Desired Tasks Count

The desired number of instantiations of the task definition to keep running on the Service.

IAM Role ARN

The ARN of the IAM role associated with the Service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Launch Type

The launch type on which your Service is running.

Memory Utilization (%)

The percentage of memory that is used in the service.

Name

The name of the EC2 Service

Pending Tasks Count

The number of tasks in the cluster that are in the PENDING state.

Platform Version

The platform version on which your task is running.

Region

The AWS Region this object belongs to.

Running Tasks Count

The number of tasks in the cluster that are in the RUNNING state.

Status

The status of the Service.

Task Definition

The task definition to use for tasks in the Service.

VPC Assign Public IP

Specifies whether or not the task's elastic network interface receives a public IP address.

VPC Security Groups

The security groups associated with the Service.

VPC Subnets

The subnets associated with the Service.

Task

Name
Description

ARN

The ARN of this Task.

Cluster ARN

The ARN of the cluster that hosts this Task.

Connected Time

The time when this Task last entered a CONNECTED state.

Connection Status

The connectivity status of this Task.

Container Instance ARN

The ARN of the container instance that hosts this Task.

CPU Units

The number of CPU units used by this Task.

Created Time

The time when this Task was created (entered the PENDING state).

Definition ARN

The ARN of the task definition that creates this Task.

Desired Status

The desired status of this Task.

Execution Stopped Time

The time when the execution of this Task stopped.

Group

The name of the group associated with this Task.

ID

The ID of the Task.

Last Status

The last known status of this Task.

Launch Type

The launch type on which this Task is running.

Memory (Mebibytes)

The amount of memory used by this Task.

Next Stop Time

The time for when this Task will stop.

Platform Version

The platform version on which this Task is running.

Pull Started Time

The time when the container image pull began.

Pull Stopped Time

The time when the container image pull completed.

Region

The AWS Region this object belongs to.

Started By

The tag specified when this Task is started.

Started Time

The time for when this Task started (transitioned from the PENDING to RUNNING state).

Stopped Reason

The reason that this Task was stopped.

Stopped Time

The time for when this Task was stopped (transitioned from the RUNNING to STOPPED state).

Version Counter

The version counter for this Task.