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 EC2

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": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "elasticloadbalancing:DescribeLoadBalancers",
        "ec2:DescribeInstances",
        "ec2:DescribeAddresses",
        "elasticloadbalancing:DescribeListeners",
        "ec2:DescribeVolumes",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics",
        "ec2:DescribeInstanceStatus"
      ],
      "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.
Include ImagesWhether or not to collect information about Amazon Machine Images (AMIs)

Metrics

Image

NameDescription
Disk ReadsCompleted read operations from all instance store volumes available to the instance in a specified period of time.
Disk WritesCompleted write operations to all instance store volumes available to the instance in a specified period of time.
Image IdThis dimension filters the data you request for all instances running this Amazon EC2 Amazon Machine Image (AMI). Available for instances with Detailed Monitoring enabled.
Instance IdThis dimension filters the data you request for the identified instance only. This helps you pinpoint an exact instance from which to monitor data.
RegionThe AWS Region this object belongs to.

Instance

NameDescription
AMI IDAMI ID of related AMI of the instance.
ArchitectureArchitecture of the instance.
Auto Scaling Group NameThis dimension filters the data you request for all instances in a specified capacity group. An Auto Scaling group is a collection of instances you define if you're using Auto Scaling. This dimension is available only for Amazon EC2 metrics when the instances are in such an Auto Scaling group. Available for instances with Detailed or Basic Monitoring enabled.
Average Network Packets InThe average number of packets received on all network interfaces by the instance. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
Average Network Packets OutThe average number of packets sent out on all network interfaces by the instance. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
CPU Credit BalanceThe number of earned CPU credits accumulated since the instance was launched, less the credits used, up to a maximum number based on the instance size.
CPU Credit UsageThe number of CPU credits used by the instance for CPU utilization. One CPU credit equals one vCPU running at 100% utilization for one minute or an equivalent combination of vCPUs, utilization, and time.
CPU Surplus Credit BalanceThe number of surplus credits that have been used by a T2 Unlimited instance when its CPUCreditBalance is zero.
CPU Surplus Credits ChargedThe number of surplus credits that have been used by a T2 Unlimited instance that are not offset by earned CPU credits. CPUSurplusCreditsCharged tracks the surplus credits that incur an additional charge, and represents the difference between CPUSurplusCreditBalance and CPUCreditBalance.
CPU Utilization (%)The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application upon a selected instance.
Disk Read Data (Bytes)Bytes read from all instance store volumes available to the instance.
Disk ReadsCompleted read operations from all instance store volumes available to the instance in a specified period of time.
Disk Write Data (Bytes)Bytes read from all instance store volumes available to the instance.
Disk WritesCompleted write operations to all instance store volumes available to the instance in a specified period of time.
DomainDomain of the instance.
EBS Data Balance (%)Available only for the smaller C5 and M5 instance sizes. Provides information about the percentage of throughput credits remaining in the burst bucket. This metric is available for basic monitoring only.
EBS IDEBS used for data storage for this instance.
EBS OptimizedWhether or not the instance is EBS optimized.
EBS Read Data (Bytes)Bytes read from all EBS volumes attached to the instance in a specified period of time.
EBS ReadsCompleted read operations from all Amazon EBS volumes attached to the instance in a specified period of time.
EBS Write Data (Bytes)Bytes written to all EBS volumes attached to the instance in a specified period of time.
EBS WritesCompleted write operations to all EBS volumes attached to the instance in a specified period of time.
EBSIO Balance (%)Available only for the smaller C5 and M5 instance sizes. Provides information about the percentage of I/O credits remaining in the burst bucket. This metric is available for basic monitoring only.
ELB DNS NameElastic Load Balancer the instance is on.
HypervisorHypervisor of the instance.
Image IDImage ID of the instance.
Instance IdThis dimension filters the data you request for the identified instance only. This helps you pinpoint an exact instance from which to monitor data.
Instance TypeThis dimension filters the data you request for all instances running with this specified instance type. This helps you categorize your data by the type of instance running. For example, you might compare data from an m1.small instance and an m1.large instance to determine which has the better business value for your application. Available for instances with Detailed Monitoring enabled.
IP AddressPublic IP Address of the instance.
Kernel IDKernel ID of the instance.
LifecycleLifecycle of the instance.
Maximum Network Packets InThe maximum number of packets received on all network interfaces by the instance. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
Maximum Network Packets OutThe maximum number of packets sent out on all network interfaces by the instance. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
Minimum Network Packets InThe minimum number of packets received on all network interfaces by the instance. This metric identifies the volume of incoming traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
Minimum Network Packets OutThe minimum number of packets sent out on all network interfaces by the instance. This metric identifies the volume of outgoing traffic in terms of the number of packets on a single instance. This metric is available for basic monitoring only.
Network InThe number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to a single instance.
Network Interface IDNetwork Interface ID of the instance.
Network Out (Bytes)The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from a single instance.
PlatformPlatform of the instance.
Public DNS NamePublic DNS name of the instance.
RegionThe AWS Region this object belongs to.
Root Device NameRoot device of the instance.
Root Device TypeRoot device type of the instance.
StateInstance status name of the instance.
StatusInstance status of the instance.
Status Check FailedReports whether the instance has passed both the instance status check and the system status check in the last minute.
Status Check Failed InstanceReports whether the instance has passed the instance status check in the last minute.
Status Check Failed SystemReports whether the instance has passed the system status check in the last minute.
Subnet IDSubnet type of the instance.
System StatusSystem status of the instance.
TagsThe tags attached to this object.
TypeType of the instance.
Virtualization TypeVirtualization type of the instance.
VPC IDVCP on which the instance is running.

Updated 8 months ago

Amazon EC2


Suggested Edits are limited on API Reference Pages

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