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 Auto Scaling

Least Privilege 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.

For more information, see: High Level AWS Source Configuration

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "autoscaling:Describe*",
                "cloudwatch:Describe*",
                "cloudwatch:Get*",
                "cloudwatch:List*",
                "logs:Get*",
                "logs:List*",
                "logs:Describe*",
                "logs:TestMetricFilter",
                "logs:FilterLogEvents",
                "sns:Get*",
                "sns:List*"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

Connection Parameters

NameRequired?Description
Region
Access Key IDRequired
Secret Access KeyRequired
Additional ThreadsThe 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 ModeIf enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.
Include Scaling Activities
Include Account Limits
Include Auto Scaling Instances
Include Launch Configurations
Include Scaling Policies

Metrics

Account Limits

NameDescription
Auto Scaling Group Usage (%)Number of Auto Scaling Groups as a percent of the maximum allowed groups by the AWS Account
Launch Configuration Usage (%)Number of Launch Configurations as a percent of the maximum allowed groups by the AWS Account
Maximum Number of Auto Scaling GroupsThe maximum number of groups allowed for your AWS account.
Maximum Number of Launch ConfigurationsThe maximum number of launch configurations allowed for your AWS account.
Number of Auto Scaling GroupsThe current number of groups for your AWS account.
Number of Launch ConfigurationsThe current number of launch configurations for your AWS account.
RegionThe AWS Region this object belongs to.

Auto Scaling Group

NameDescription
ARNThe Amazon Resource Name (ARN) of the Auto Scaling group.
Availability ZoneOne or more Availability Zones for the group.
Created TimeThe date and time the group was created.
Default Cooldown (Seconds)The amount of time after a scaling activity completes before another scaling activity can start.
Desired CapacityThe number of instances that the Auto Scaling group attempts to maintain.
Health Check TypeThe service to use for the health checks.
In-Service InstancesThe number of instances that are running as part of the Auto Scaling group. This metric does not include instances that are pending or terminating.
Launch Configuration NameThe name of the associated launch configuration.
Launch Template IDThe launch template for the group
Load BalancersOne of more load balancers associated with the group
Maximum SizeThe maximum size of the Auto Scaling group.
Minimum SizeThe minimum size of the Auto Scaling group.
NameThe name of the Auto Scaling group.
Pending InstancesThe number of instances that are pending. A pending instance is not yet in service. This metric does not include instances that are in service or terminating.
Placement GroupThe name of the placement group into which you'll launch your instances, if any.
RegionThe AWS Region this object belongs to.
Standby InstancesThe number of instances that are in a Standby state. Instances in this state are still running but are not actively in service.
StatusThe current state of the group when DeleteAutoScalingGroup is in progress.
TagsThe tags attached to this object.
Target Group ARNsThe Amazon Resource Names (ARN) of the target groups for your load balancer.
Terminating InstancesThe number of instances that are in the process of terminating. This metric does not include instances that are in service or pending.
Total InstancesThe total number of instances in the Auto Scaling group. This metric identifies the number of instances that are in service, pending, and terminating.
VPC ZoneOne or more subnet IDs, if applicable, sparated by commas.

Auto Scaling Instance

NameDescription
Availability ZoneThe Availability Zone for the instance.
Group NameThe name of the Auto Scaling group for the instance.
Health StatusThe last reported health status of this instance.
IDThe ID of the instance.
Launch Configuration NameThe launch configuration used to launch the instance.
Launch Template IDThe launch template for the instance.
Lifecycle StateThe lifecycle state for the instance.
RegionThe AWS Region this object belongs to.

Launch Configuration

NameDescription
ARNThe Amazon Resource Name (ARN) of the launch configuration.
Associate Public IP Address[EC2-VPC] Indicates whether to assign a public IP address to each instance.
Created TimeThe creation date and time for the launch configuration.
EBS OptimizedControls whether the instance is optimized for EBS I/O (true) or not (false).
IAM ARNThe name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Image IDThe ID of the Amazon Machine Image (AMI).
Instance TypeThe instance type for the instances.
Kernel IDThe ID of the kernel associated with the AMI.
NameThe name of the launch configuration.
Placement TenancyThe tenancy of the instance, either default or dedicated.
RAM Disk IDThe ID of the RAM disk associated with the AMI.
RegionThe AWS Region this object belongs to.
Security GroupsThe security groups to associate with the instances.
VPC IDThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

Scaling Activity

NameDescription
CauseThe reason the activity began.
DescriptionA friendly, more verbose description of the activity.
DetailsThe details about the activity
End TimeThe end time of the activity.
Group NameThe name of the Auto Scaling group.
IDThe ID of the activity.
ProgressA value between 0 and 100 that indicates the progress of the activity.
RegionThe AWS Region this object belongs to.
Start TimeThe start time of the activity.
Status CodeThe current status of the activity.
Status MessageA friendly, more verbose description of the activity status.

Scaling Policy

NameDescription
ARNThe Amazon Resource Name (ARN) of the policy.
Cooldown (Seconds)The amount of time after a scaling activity completes before any further dynamic scaling activities can start.
Group NameThe name of the Auto Scaling group.
NameThe name of the scaling policy.
RegionThe AWS Region this object belongs to.
TypeThe policy type.

Updated 8 months ago

Amazon Auto Scaling


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.