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 CloudSearch

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": [
        "cloudsearch:DescribeServiceAccessPolicies",
        "cloudsearch:DescribeSuggesters",
        "cloudsearch:DescribeAvailabilityOptions",
        "cloudwatch:GetMetricData",
        "cloudsearch:search",
        "cloudsearch:ListTags",
        "cloudwatch:GetMetricStatistics",
        "cloudsearch:ListDomainNames",
        "cloudwatch:ListMetrics",
        "cloudsearch:DescribeScalingParameters",
        "cloudwatch:DescribeAlarmHistory",
        "cloudsearch:DescribeIndexFields",
        "cloudwatch:DescribeAlarmsForMetric",
        "cloudwatch:DescribeAlarms",
        "cloudsearch:DescribeAnalysisSchemes",
        "cloudsearch:DescribeExpressions",
        "cloudsearch:DescribeDomains",
        "cloudsearch:suggest"
      ],
      "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

Domain

Name
Description

Client ID

The AWS account ID.

Index Utilization (%)

The percentage of the search instance's index capacity that has been used.

Name

The name of the search domain.

Partitions

The number of partitions the index is distributed across.

Region

The AWS Region this object belongs to.

Searchable Documents

The number of searchable documents in the domain's search index.

Successful Requests

The number of search requests successfully processed by a search instance.