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!

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": "LpuPolicy",
      "Effect": "Allow",
      "Action": [
        "rds:ListTagsForResource",
        "rds:DescribeDBSnapshots",
        "rds:DescribeDBInstances",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

Name
Required?
Description

Region

Access Key ID

Required

Secret Access Key

Required

Collect Tags

Filter

Used to filter DB Instances in combination with conditions.

Conditions

Required

Used with filter parameter to determine how to filter DB Instances.

Metrics

Cluster

Name
Description

Allocated Storage (Gibibytes)

The Allocated Storage of the Cluster.

Backup Retention Period (Days)

The Backup Retention Period of the Cluster.

Character Set Name

The Character Set Name of the Cluster.

Clone Group ID

The Clone Group ID of the Cluster.

Cluster Create Time

The Cluster Create Time of the Cluster.

Cluster Identifier

The Cluster Identifier of the Cluster.

Cluster Parameter Group

The Cluster Parameter Group of the Cluster.

Earliest Restorable Time

The Earliest Restorable Time of the Cluster.

Endpoint

The Endpoint of the Cluster.

Engine

The Engine of the Cluster.

Engine Version

The Engine Version of the Cluster.

IAM Database Authentication Enabled

Indicates if the Cluster has IAM Database Authentication enabled.

KMS Key ID

The KMS Key ID of the Cluster.

Latest Restorable Time

The Latest Restorable Time of the Cluster.

Master Username

The Master Username of the Cluster.

Multi AZ

Indicates if the Cluster has Multi Availability Zone enabled.

Port

The Port of the Cluster.

Preferred Backup Window

The Preferred Backup Window of the Cluster.

Preferred Maintenance Window

The Preferred Maintenance Window of the Cluster.

Progress

The Percent Progress of the Cluster.

Reader Endpoint

The Reader Endpoint of the Cluster.

Region

The AWS Region this object belongs to.

Replication Source Identifier

The Replication Source Identifier of the Cluster.

Status

The Status of the Cluster.

Storage Encrypted

Indicates if the Cluster has Storage Encrypted enabled.

Subnet Group Name

The Subnet Group Name of the Cluster.

Instance

Name
Description

Allocated Storage (Gibibytes)

The Allocated Storage of the RDS Instance.

Auto Minor Version Upgrade

Indicates if the RDS Instance will Automatically Upgrade Minor Version.

Availability Zone

The Availability Zone of the RDS Instance.

Backup Retention Period (Days)

The Backup Retention Period of the RDS Instance.

Binary Log Disk Usage (Bytes)

The Binary Log Disk Usage of the RDS Instance.

CA Certificate Identifier

The CA Certificate Identifier of the RDS Instance.

Character Set Name

The Character Set Name of the RDS Instance.

Class

The Class of the RDS Instance.

Cluster Identifier

The Cluster Identifier of the RDS Instance.

Copy Tags to Snapshot

Indicates if the RDS Instance will Copy Tags to Snapshot.

CPU Credit Balance

The CPU Credit Balance of the RDS Instance.

CPU Credit Usage

The CPU Credit Usage of the RDS Instance.

CPU Utilization (%)

The CPU Utilization of the RDS Instance.

Database Connections

The Database Connections of the RDS Instance.

DBI Resource ID

The DBI Resource ID of the RDS Instance.

Disk Queue Depth

The Disk Queue Depth of the RDS Instance.

Endpoint Address

The Endpoint Address of the RDS Instance.

Endpoint Hosted Zone ID

The Endpoint Hosted Zone ID of the RDS Instance.

Endpoint Port

The Endpoint Port of the RDS Instance.

Engine

The Engine of the RDS Instance.

Engine Version

The Engine Version of the RDS Instance.

Enhanced Monitoring Resource ARN

The Enhanced Monitoring Resource ARN of the RDS Instance.

Free Storage Space (Bytes)

The Free Storage Space of the RDS Instance.

Freeable Memory (Bytes)

The Freeable Memory of the RDS Instance.

Identifier

The Identifier of the RDS Instance.

Instance Create Time

The Instance Create Time of the RDS Instance.

KMS Key ID

The KMS Key ID of the RDS Instance.

Latest Restorable Time

The Latest Restorable Time of the RDS Instance.

License Model

The License Model of the RDS Instance.

Master Username

The Master Username of the RDS Instance.

Monitoring Interval (Seconds)

The Monitoring Interval of the RDS Instance.

Monitoring Role ARN

The Monitoring Role ARN of the RDS Instance.

Multi AZ

Indicates if the RDS Instance has Multi Availability Zone enabled.

Name

The Name of the RDS Instance.

Network Receive Throughput (Bytes per Second)

The Network Receive Throughput of the RDS Instance.

Network Transmit Throughput (Bytes per Second)

The Network Transmit Throughput of the RDS Instance.

Port

The Port of the RDS Instance.

Preferred Backup Window

The Preferred Backup Window of the RDS Instance.

Preferred Maintenance Window

The Preferred Maintenance Window of the RDS Instance.

Provisioned IO Rate (per Second)

The Provisioned IOPS of the RDS Instance.

Publicly Accessible

Indicates if the RDS Instance is Publicly Accessible.

Read IO Rate (per Second)

The Read IOPS of the RDS Instance.

Read Latency (Seconds)

The Read Latency of the RDS Instance.

Read Replica Source DB Instance Identifier

The Read Replica Source DB Instance Identifier of the RDS Instance.

Read Throughput (Bytes per Second)

The Read Throughput of the RDS Instance.

Region

The AWS Region this object belongs to.

Secondary Availability Zone

The Secondary Availability Zone of the RDS Instance.

Status

The Status of the RDS Instance.

Storage Encrypted

Indicates if the RDS Instance has Storage Encrypted enabled.

Storage Type

The Storage Type of the RDS Instance.

Subnet Group Description

The Subnet Group Description of the RDS Instance.

Subnet Group Name

The Subnet Group Name of the RDS Instance.

Subnet Group Status

The Subnet Group Status of the RDS Instance.

Subnet Group VPC ID

The Subnet Group VPC ID of the RDS Instance.

Swap Usage (Bytes)

The Swap Usage of the RDS Instance.

TDE Credential ARN

The TDE Credential ARN of the RDS Instance.

Transaction Logs Disk Usage (Bytes)

The Transaction Logs Disk Usage of the RDS Instance.

Write IO Rate (per Second)

The Write IOPS of the RDS Instance.

Write Latency (Seconds)

The Write Latency of the RDS Instance.

Write Throughput (Bytes per Second)

The Write Throughput of the RDS Instance.

Snapshot

Name
Description

Allocated Storage (Gibibytes)

The Allocated Storage of the RDS Snapshot.

Availability Zone

The Availability Zone of the RDS Snapshot.

DB Instance Identifier

The DB Instance Identifier of the RDS Snapshot.

Encrypted

Indicated if the RDS Snapshot is Encrypted.

Engine Version

The Engine Version of the RDS Snapshot.

KMS Key ID

The KMS Key ID of the RDS Snapshot.

License Model

The License Model of the RDS Snapshot.

Master Username

The Master Username of the RDS Snapshot.

Option Group Name

The Option Group Name of the RDS Snapshot.

Port

The Port of the RDS Snapshot.

Progress

The Percent Progress of the RDS Snapshot.

Provisioned IO Rate (per Second)

The Provisioned IOPS of the RDS Snapshot.

Region

The AWS Region this object belongs to.

Snapshot Create Time

The Create Time of the RDS Snapshot.

Snapshot Identifier

The Snapshot Identifier of the RDS Snapshot.

Snapshot Type

The Snapshot Type of the RDS Snapshot.

Source Region

The Source Region of the RDS Snapshot.

Status

The Status of the RDS Snapshot.

Storage Type

The Storage Type of the RDS Snapshot.

TDE Credential ARN

The TDE Credential ARN of the RDS Snapshot.

VPC ID

The VPC ID of the RDS Snapshot.

Tag

Name
Description

Instance ID

The Instance ID of the Tag.

Name

The Name of the Tag.

Value

The Value of the Tag.