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.

For more information, see: High Level AWS Source Configuration

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

Connection Parameters

NameRequired?Description
Region
Access Key IDRequired
Secret Access KeyRequired
Additional ThreadsThe 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 ModeIf enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Cluster

NameDescription
Active EC2 Services CountThe number of EC2 services that are running on this Cluster in an ACTIVE state.
Active Fargate Services CountThe number of Fargate services that are running on this Cluster in an ACTIVE state.
Active ServicesThe number of services that are running on this Cluster in an ACTIVE state.
ARNThe 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 CountThe number of EC2 services that are running on this Cluster in a DRAINING state.
Draining Fargate Services CountThe 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.
NameThe name of the EC2 Cluster
Pending EC2 Tasks CountThe number of EC2 tasks in this Cluster that are in the PENDING state.
Pending Fargate Tasks CountThe number of Fargate tasks in this Cluster that are in the PENDING state.
Pending Tasks CountThe number of tasks in this Cluster that are in the PENDING state.
RegionThe AWS Region this object belongs to.
Registered Container Instances CountThe number of container instances registered to this Cluster.
Running EC2 Tasks CountThe number of EC2 tasks in this Cluster that are in the RUNNING state.
Running Fargate Tasks CountThe number of Fargate tasks in this Cluster that are in the RUNNING state.
Running Tasks CountThe number of tasks in this Cluster that are in the RUNNING state.
StatusThe status of this Cluster.

Container Instance

NameDescription
Agent ConnectedIf the agent is connected to Amazon ECS.
Agent HashThe git commit hash of the Amazon ECS container agent build.
Agent Update StatusStatus of the most recent agent update.
Agent VersionThe version of the Amazon ECS container agent.
ARNThe ARN of the Container Instance.
Cluster ARNThe Amazon Resource Name (ARN) of the cluster that hosts this Instance.
Docker VersionThe Docker version running on the Container Instance.
EC2 Instance IDThe EC2 Instance ID of the Container Instance.
IDThe ID of the Container Instance.
Pending Tasks CountThe number of tasks on the Container Instance that are in the Pending state.
RegionThe AWS Region this object belongs to.
Registered TimeThe time for when the Container Instance was registered.
Running Tasks CountThe number of tasks on the Container Instance that are in the Running state.
StatusThe status of the Container Instance.
Version CounterThe version counter for the Container Instance.

Service

NameDescription
ARNThe ARN that identifies the Service.
Cluster ARNThe Amazon Resource Name (ARN) of the cluster that hosts this Service.
Cluster NameThe name of the EC2 Cluster
CPU Utilization (%)The percentage of CPU units that are used in the service.
Created TimeThe 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 CountThe desired number of instantiations of the task definition to keep running on the Service.
IAM Role ARNThe 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 TypeThe launch type on which your Service is running.
Memory Utilization (%)The percentage of memory that is used in the service.
NameThe name of the EC2 Service
Pending Tasks CountThe number of tasks in the cluster that are in the PENDING state.
Platform VersionThe platform version on which your task is running.
RegionThe AWS Region this object belongs to.
Running Tasks CountThe number of tasks in the cluster that are in the RUNNING state.
StatusThe status of the Service.
Task DefinitionThe task definition to use for tasks in the Service.
VPC Assign Public IPSpecifies whether or not the task's elastic network interface receives a public IP address.
VPC Security GroupsThe security groups associated with the Service.
VPC SubnetsThe subnets associated with the Service.

Task

NameDescription
ARNThe ARN of this Task.
Cluster ARNThe ARN of the cluster that hosts this Task.
Connected TimeThe time when this Task last entered a CONNECTED state.
Connection StatusThe connectivity status of this Task.
Container Instance ARNThe ARN of the container instance that hosts this Task.
CPU UnitsThe number of CPU units used by this Task.
Created TimeThe time when this Task was created (entered the PENDING state).
Definition ARNThe ARN of the task definition that creates this Task.
Desired StatusThe desired status of this Task.
Execution Stopped TimeThe time when the execution of this Task stopped.
GroupThe name of the group associated with this Task.
IDThe ID of the Task.
Last StatusThe last known status of this Task.
Launch TypeThe launch type on which this Task is running.
Memory (Mebibytes)The amount of memory used by this Task.
Next Stop TimeThe time for when this Task will stop.
Platform VersionThe platform version on which this Task is running.
Pull Started TimeThe time when the container image pull began.
Pull Stopped TimeThe time when the container image pull completed.
RegionThe AWS Region this object belongs to.
Started ByThe tag specified when this Task is started.
Started TimeThe time for when this Task started (transitioned from the PENDING to RUNNING state).
Stopped ReasonThe reason that this Task was stopped.
Stopped TimeThe time for when this Task was stopped (transitioned from the RUNNING to STOPPED state).
Version CounterThe version counter for this Task.

Updated 8 months ago

Amazon ECS


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.