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 S3

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": "Stmt1510751424000",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:GetMetricStatistics",
        "s3:ListAllMyBuckets"
      ],
      "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

Bucket

Name
Description

4xx Errors

The number of HTTP 4xx client error status code requests made to a bucket with a value of 0 or 1. The average statistic shows the error rate, and the sum statistic shows the count of that type of error, during each period.

5xx Errors

The number of HTTP 5xx server error status code requests made to a bucket with a value of either 0 or 1. The average statistic shows the error rate, and the sum statistic shows the count of that type of error, during each period.

Accelerate Configuration Status

The current status of the accelerate configuration for this bucket.

Accelerate Enabled

Signals if Accelerate Configuration is enabled.

All Requests Maximum (Bytes)

The number bytes uploaded to a bucket that contain a request body.

All Requests Minimum (Bytes)

The number bytes uploaded to a bucket that contain a request body.

All Requests Sample Count (Bytes)

The number bytes uploaded to a bucket that contain a request body.

All Requests Sum (Bytes)

The number bytes uploaded to a bucket that contain a request body.

Average All Requests (Bytes)

The number bytes uploaded to a bucket that contain a request body.

Average Data Downloaded (Bytes)

The number bytes downloaded for requests made to a bucket, where the response includes a body.

Average First Byte Latency (Milliseconds)

The per-request time from the complete request being received by a bucket to when the response starts to be returned.

Average Total Request Latency (Milliseconds)

The elapsed per-request time from the first byte received to the last byte sent to a bucket. This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Creation Date

The creation date of this bucket.

Data Downloaded Sample Count (Bytes)

The number bytes downloaded for requests made to a bucket, where the response includes a body.

Data Downloaded Sum (Bytes)

The number bytes downloaded for requests made to a bucket, where the response includes a body.

Delete Requests

The number of HTTP DELETE requests made for objects in a bucket. This also includes Delete Multiple Objects requests.

First Byte Latency Maximum (Milliseconds)

The per-request time from the complete request being received by a bucket to when the response starts to be returned.

First Byte Latency Minimum (Milliseconds)

The per-request time from the complete request being received by a bucket to when the response starts to be returned.

First Byte Latency Sample Count (Milliseconds)

The per-request time from the complete request being received by a bucket to when the response starts to be returned.

First Byte Latency Sum (Milliseconds)

The per-request time from the complete request being received by a bucket to when the response starts to be returned.

Get Requests

The number of HTTP GET requests made for objects in a bucket. This doesn't include list operations.

Head Requests

The number of HTTP HEAD requests made to a bucket.

List Requests

The number of HTTP requests that list the contents of a bucket.

Log File Prefix

Optional log file prefix.

Logging Enabled

Signals if Logging Configuration is enabled.

Maximum Data Downloaded (Bytes)

The number bytes downloaded for requests made to a bucket, where the response includes a body.

Minimum Data Downloaded (Bytes)

The number bytes downloaded for requests made to a bucket, where the response includes a body.

Name

The name of this S3 bucket.

Number Of Objects

The total number of objects stored in a bucket for all storage classes except for the GLACIER storage class.

Owner ID

The owner ID of this bucket.

Owner Name

The owner name of this bucket.

Post Requests

The number of HTTP POST requests made to a bucket.

Put Requests

The number of HTTP PUT requests made for objects in a bucket.

Reduced Redundancy Bucket Size (Bytes)

The amount of data in bytes stored in a bucket in the Reduced Redundancy Storage (RRS) storage class.

Region

The AWS Region this object belongs to.

Replication Role ARN

Returns the IAM role associated with this replication configuration.

Standard IA Storage Bucket Size (Bytes)

The amount of data in bytes stored in a bucket in the Standard - Infrequent Access (Standard_IA) storage class.

Standard Storage Bucket Size (Bytes)

The amount of data in bytes stored in a bucket in the Standard storage class.

Tags

The tags on this bucket.

Total Request Latency Maximum (Milliseconds)

The elapsed per-request time from the first byte received to the last byte sent to a bucket. This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Total Request Latency Minimum (Milliseconds)

The elapsed per-request time from the first byte received to the last byte sent to a bucket. This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Total Request Latency Sample Count (Milliseconds)

The elapsed per-request time from the first byte received to the last byte sent to a bucket. This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Total Request Latency Sum (Milliseconds)

The elapsed per-request time from the first byte received to the last byte sent to a bucket. This includes the time taken to receive the request body and send the response body, which is not included in FirstByteLatency.

Uploaded Per Request (Bytes)

The average number bytes uploaded for requests made to a bucket, where the response includes a body.

Uploaded Throughput (Bytes per Second)

The total number bytes uploaded for requests made to a bucket, where the response includes a body.