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 Elastic File System

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": [
        "elasticfilesystem:DescribeMountTargets",
        "elasticfilesystem:DescribeFileSystems"
      ],
      "Resource": "arn:aws:elasticfilesystem:*:*:file-system/*"
    },
    {
      "Sid": "VisualEditor1",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:GetMetricStatistics",
        "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

File System

Name
Description

Burst Credit Balance (Bytes)

The number of burst credits that a file system has.

Client Connections

The maximum number of client connections to a file system within the collection period.

Encrypted

Indicates that the file system is encrypted.

Id

The identifier associated with the file system.

I/O Limit (%)

Shows how close a file system is to reaching the I/O limit of the General Purpose performance mode.

KMS Key ID

The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.

Life Cycle State

Lifecycle phase of the file system.

Metadata I/O (Bytes)

The number of bytes for each metadata operation.

Name

The name given to this file system.

Number of Mount Targets (Connections)

The number of mount targets that the file system has.

Owner ID

AWS account that created the file system.

Performance Mode

The PerformanceMode of the file system.

Permitted Throughput (Bytes per Second)

The maximum amount of throughput a file system is allowed, given the file system size and BurstCreditBalance.

Read I/O (Bytes)

The number of bytes for each file system read operation.

Region

The AWS Region this object belongs to.

Size (Bytes)

Latest known metered size of data stored in the file system.

Total I/O (Bytes)

The number of bytes for each file system operation, including data read, data write, and metadata operations.

Write I/O (Bytes)

The number of bytes for each file system write operation.