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 Redshift

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": "redshifLpu",
      "Effect": "Allow",
      "Action": [
        "redshift:DescribeClusters",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

NameRequired?Description
Access Key IDRequired
Secret Access KeyRequired
Region
Cluster IDs
Cluster Tags
Period

Metrics

Cluster

NameDescription
Allow Version UpgradeA Boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
Automated Snapshot Retention Period (Days)The number of days that automatic cluster snapshots are retained.
Availability ZoneThe name of the Availability Zone in which the cluster is located.
Cluster EndpointThe endpoint of the cluster.
Cluster IdentifierThe unique identifier of the cluster.
Cluster StatusThe current state of the cluster.
Cluster TagsThe list of tags for the cluster.
CPU Utilization (%)The percentage of CPU utilization
Create TimeThe date and time that the cluster was created.
Database Connections (Connections)The number of database connections to a cluster.
Disk Space Utilization (%)The percent of disk space used.
EncryptedA Boolean value that, if true, indicates that data in the cluster is encrypted at rest.
HealthyIndicates the health of the cluster.
Maintenance ModeIndicates whether the cluster is in maintenance mode.
Network Receive Throughput (Bytes per Second)The rate at which the cluster receives data.
Network Transmit Throughput (Bytes per Second)The rate at which the cluster writes data.
Number Of Compute NodesThe number of compute nodes in the cluster.
Preferred Maintenance WindowThe weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Publicly AccessibleA Boolean value that, if true, indicates that the cluster can be accessed from a public network.
Read IO Rate (Operations per Second)The average number of disk read operations per second across all nodes.
Read Latency (Seconds)The average amount of time taken for disk read I/O operations across all nodes.
Read Throughput (Bytes per Second)The average number of bytes read from disk per second across all nodes.
RegionThe AWS Region this object belongs to.
Revision NumberThe specific revision number of the database in the cluster.
Subnet Group NameThe name of the subnet group that is associated with the cluster.
VersionThe version ID of the Amazon Redshift engine that is running on the cluster.
Write IO Rate (Operations per Second)The average number of write operations per second across all nodes.
Write Latency (Seconds)The average amount of time taken for disk write I/O operations across all nodes.
Write Throughput (Bytes per Second)The average number of bytes written to disk per second across all nodes.

Node

NameDescription
CPU Utilization (%)The percentage of CPU utilization.
Disk Space Utilization (%)The percent of disk space used.
Network Receive Throughput (Bytes per Second)The rate at which the node receives data.
Network Transmit Throughput (Bytes per Second)The rate at which the node transmits data.
Node IDThe ID of the Node.
Node RoleThe role of the node.
Private IP AddressThe private IP address of a node within a cluster.
Public IP AddressThe public IP address of a node within a cluster.
Read IO Rate (Operations per Second)The average number of disk read operations per second.
Read Latency (Seconds)The average amount of time taken for disk read I/O operations.
Read Throughput (Bytes per Second)The average number of bytes read from disk per second.
RegionThe AWS Region this object belongs to.
Write IO Rate (Operations per Second)The average number of write operations per second.
Write Latency (Seconds)The average amount of time taken for disk write I/O operations.
Write Throughput (Bytes per Second)The average number of bytes written to disk per second.

Updated 8 months ago

Amazon Redshift


Suggested Edits are limited on API Reference Pages

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