Skip to content
AWS for Query.Farm

aws.opsworks.describe_load_based_auto_scaling

Example SQL Queries

SELECT * FROM
aws.opsworks.describe_load_based_auto_scaling
WHERE
"layer_ids" = 'VALUE';

Description

Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Table Definition

Column NameColumn Data Type
layer_ids Required Input Column

An array of layer IDs.

VARCHAR[]
Show child fields
layer_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
load_based_auto_scaling_configurations

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

STRUCT(
    "layer_id" VARCHAR,
    "enable" BOOLEAN,
    "up_scaling" STRUCT(
        "instance_count" BIGINT,
        "thresholds_wait_time" BIGINT,
        "ignore_metrics_time" BIGINT,
        "cpu_threshold" DOUBLE,
        "memory_threshold" DOUBLE,
        "load_threshold" DOUBLE,
        "alarms" VARCHAR[]
    ),
    "down_scaling" STRUCT(
        "instance_count" BIGINT,
        "thresholds_wait_time" BIGINT,
        "ignore_metrics_time" BIGINT,
        "cpu_threshold" DOUBLE,
        "memory_threshold" DOUBLE,
        "load_threshold" DOUBLE,
        "alarms" VARCHAR[]
    )
)[]
Show child fields
load_based_auto_scaling_configurations[]
Show child fields
load_based_auto_scaling_configurations[].down_scaling

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when OpsWorks Stacks reduces the number of instances.

Show child fields
load_based_auto_scaling_configurations[].down_scaling.alarms[]
load_based_auto_scaling_configurations[].down_scaling.cpu_threshold

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

load_based_auto_scaling_configurations[].down_scaling.ignore_metrics_time

The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

load_based_auto_scaling_configurations[].down_scaling.instance_count

The number of instances to add or remove when the load exceeds a threshold.

load_based_auto_scaling_configurations[].down_scaling.load_threshold

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

load_based_auto_scaling_configurations[].down_scaling.memory_threshold

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

load_based_auto_scaling_configurations[].down_scaling.thresholds_wait_time

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

load_based_auto_scaling_configurations[].enable

Whether load-based auto scaling is enabled for the layer.

load_based_auto_scaling_configurations[].layer_id

The layer ID.

load_based_auto_scaling_configurations[].up_scaling

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when OpsWorks Stacks increases the number of instances.

Show child fields
load_based_auto_scaling_configurations[].up_scaling.alarms[]
load_based_auto_scaling_configurations[].up_scaling.cpu_threshold

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

load_based_auto_scaling_configurations[].up_scaling.ignore_metrics_time

The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

load_based_auto_scaling_configurations[].up_scaling.instance_count

The number of instances to add or remove when the load exceeds a threshold.

load_based_auto_scaling_configurations[].up_scaling.load_threshold

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

load_based_auto_scaling_configurations[].up_scaling.memory_threshold

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

load_based_auto_scaling_configurations[].up_scaling.thresholds_wait_time

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.