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 API Gateway

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": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:DescribeAlarmHistory",
        "cloudwatch:GetMetricData",
        "cloudwatch:DescribeAlarmsForMetric",
        "apigateway:HEAD",
        "cloudwatch:DescribeAlarms",
        "apigateway:GET",
        "cloudwatch:GetMetricStatistics",
        "apigateway:OPTIONS",
        "cloudwatch:ListMetrics"
      ],
      "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

API

Name
Description

4xx Errors (Errors)

The number of client-side errors captured

5xx Errors (Errors)

The number of server-side errors captured.

Binary Media Types

The list of binary media types supported by the RestApi.

Cache Hit Count (Requests)

The number of requests served from the API cache.

Cache Miss Count (Requests)

The number of requests served from the back end when API caching is enabled.

Calls Count (Calls)

The number of calls to API methods.

Created Date

The timestamp when the API was created.

Description

The API's description.

Endpoint Configuration

The endpoint configuration of this RestApi showing the endpoint types of the API.

ID

The API's identifier.

Integration Latency (Milliseconds)

The time between when API Gateway relays a request to the back end and when it receives a response from the back end.

Key Source

The source of the API key for metring requests according to a usage plan.

Latency (Milliseconds)

The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.

Minimum Compression Size (Bytes)

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.

Name

The API's name.

Region

The AWS Region this object belongs to.

Version

A version identifier for the API.

Warnings

The warning messages reported when failonwarnings is turned on during API import.

Stage

Name
Description

4xx Errors (Errors)

The number of client-side errors captured

5xx Errors (Errors)

The number of server-side errors captured.

API Name

The name of the API associated with the stage.

Cache Cluster Enabled

Specifies whether a cache cluster is enabled for the stage.

Cache Cluster Size (Gigabytes)

The size of the cache cluster for the stage, if enabled.

Cache Cluster Status

The status of the cache cluster for the stage, if enabled.

Cache Hit Count (Requests)

The number of requests served from the API cache.

Cache Miss Count (Requests)

The number of requests served from the back end when API caching is enabled.

Calls Count (Calls)

The number of calls to API methods.

Client Certificate ID

The identifier of a client certificate for an API stage.

Created Date

The timestamp when the stage was created.

Deployment ID

The identifier of the Deployment that the stage points to.

Description

The stage's description.

Documentation Version

The version of the associated API documentation.

Full Name

The name of the Stage along with the corresponding API name.

Integration Latency (Milliseconds)

The time between when API Gateway relays a request to the back end and when it receives a response from the back end.

Last Updated Date

The timestamp when the stage was last updated.

Latency (Milliseconds)

The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.

Name

The stage's name.

Region

The AWS Region this object belongs to.

VPC Link

Name
Description

Description

The description of the VPC link.

ID

The identifier of the VPC Link.

Name

The name used to label and identify the VPC link.

Region

The AWS Region this object belongs to.

Status

The status of the VPC link.

Status Message

A description about the VPC link status.

Target ARNs

The ARNs of network load balancers of the VPC targeted by the VPC link.