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 Route 53

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": [
        "route53:ListReusableDelegationSets",
        "route53:ListTrafficPolicyInstances",
        "route53:GetHealthCheckLastFailureReason",
        "route53:GetHealthCheckStatus",
        "route53:GetTrafficPolicyInstanceCount",
        "route53:ListTrafficPolicyVersions",
        "route53:GetHostedZone",
        "route53:ListHostedZones",
        "route53:ListTrafficPolicyInstancesByHostedZone",
        "route53:GetHealthCheck",
        "route53:GetReusableDelegationSet",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics",
        "route53:ListHostedZonesByName",
        "route53:ListTrafficPolicyInstancesByPolicy",
        "route53:ListHealthChecks",
        "route53:ListTrafficPolicies",
        "route53:ListResourceRecordSets",
        "route53:GetGeoLocation",
        "route53:ListGeoLocations",
        "route53:GetTrafficPolicyInstance",
        "route53:GetHostedZoneCount",
        "route53:GetTrafficPolicy",
        "route53:GetHealthCheckCount"
      ],
      "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

Health Check

Name
Description

Alarm Comparison Operator

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

Alarm Econst Valuation Periods

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

Alarm Identifier

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Alarm Metric

The name of the CloudWatch metric that the alarm is associated with.

Alarm Namespace

The namespace of the metric that the alarm is associated with.

Alarm Period

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period.

Alarm Region

The region to which the CloudWatch alarm applies.

Alarm Statistic

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

Alarm Threshold

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

Caller Reference

A unique string that was specified when the health check was created.

Child Health Checks

A list of Child Health Check resources that are associated with the CALCULATED health check.

Children Healthy

The number of health checks that are healthy among the health checks that Amazon Route 53 is monitoring.

Failure Threshold

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Fully Qualified Domain Name

Amazon Route 53 behavior depends on whether there is a value specified for the IPAddress.

Health Threshold

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy.

Healthy (%)

The percentage of Amazon Route 53 health checkers that consider the selected endpoint to be healthy.

ID

The internal ID assigned to the health check.

Insufficient Data Health Status

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that Amazon Route 53 will assign to the health check.

Inverted

Whether Amazon Route 53 should invert the status of the health check. For example, a healthy check would be reported as unhealthy instead.

IP Address

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.

Linked Service Description

If the health check was created by another service, an optional description that can be provided by the other service.

Linked Service Principal

If the health check was created by another service, the service that created the resource.

Measure Latency

Whether Amazon Route 53 will measure the latency between health checkers in multiple AWS regions and its target endpoint.

Port

The port on the endpoint on which Amazon Route 53 will perform health checks.

Region

The AWS Region this object belongs to.

Regions

A list of Regions from which Amazon Route 53 health checkers will check the specified endpoint.

Request Interconst Value (Seconds)

The time between when Amazon Route 53 gets a response from the endpoint and the time that it sends the next health check request.

Resource Path

The path that Amazon Route 53 will request when performing health checks.

Search String

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, this is the string that Amazon Route 53 will use to search for in the response body from the specified resource.

SNI Enabled

If enabled, allows Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation.

Status

The status of the health check endpoint that CloudWatch is checking. 1 indicates healthy, and 0 indicates unhealthy.

Type

The type of health check, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

Version

The version of the health check.

Hosted Zone

Name
Description

Caller Reference

A unique string that was specified when the hosted zone was created.

Comment

User comments about the hosted zone.

ID

The ID that Amazon Route 53 assigned to the hosted zone.

Linked Service Description

If the hosted zone was created by another service, an optional description that can be provided by the other service.

Linked Service Principal

If the hosted zone was created by another service, the service that created the resource.

Name

The name of the domain.

Private

Indicates whether this is a private hosted zone.

Region

The AWS Region this object belongs to.

Resource Record Set Count

The number of resource record sets in the hosted zone.

Regional Health Check

Name
Description

Child Healthy Health Checks

The number of health checks that are healthy among the health checks that Amazon Route 53 is monitoring.

Connection Time (Milliseconds)

The average time that it took Amazon Route 53 health checkers to establish a TCP connection with the endpoint.

ID

The internal ID assigned to the health check.

Region

The AWS Region this object belongs to.

SSL Handshake Time (Milliseconds)

The average time, that it took Amazon Route 53 health checkers to complete the SSL handshake.

Status

The status of the health check endpoint that CloudWatch is checking. 1 indicates healthy, and 0 indicates unhealthy.

Time To First Byte (Milliseconds)

The average time, that it took Amazon Route 53 health checkers to receive the first byte of the response to an HTTP or HTTPS request.

Traffic Policy

Name
Description

ID

The ID that Amazon Route 53 assigned to the traffic policy.

Name

The name that was specified for the traffic policy.

Region

The AWS Region this object belongs to.

Type

The DNS type of the resource record sets that Amazon Route 53 creates when it uses a traffic policy to create a traffic policy instance.

Version

The version number of the latest version of the traffic policy.