--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_autoscaling_policy{% #aws_autoscaling_policy %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `adjustment_type`{% #adjustment_type %} **Type**: `STRING`**Provider name**: `AdjustmentType`**Description**: Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. ## `alarms`{% #alarms %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Alarms`**Description**: The CloudWatch alarms related to the policy. - `alarm_arn`**Type**: `STRING`**Provider name**: `AlarmARN`**Description**: The Amazon Resource Name (ARN) of the alarm. - `alarm_name`**Type**: `STRING`**Provider name**: `AlarmName`**Description**: The name of the alarm. ## `auto_scaling_group_name`{% #auto_scaling_group_name %} **Type**: `STRING`**Provider name**: `AutoScalingGroupName`**Description**: The name of the Auto Scaling group. ## `cooldown`{% #cooldown %} **Type**: `INT32`**Provider name**: `Cooldown`**Description**: The duration of the policy's cooldown period, in seconds. ## `enabled`{% #enabled %} **Type**: `BOOLEAN`**Provider name**: `Enabled`**Description**: Indicates whether the policy is enabled (`true`) or disabled (`false`). ## `estimated_instance_warmup`{% #estimated_instance_warmup %} **Type**: `INT32`**Provider name**: `EstimatedInstanceWarmup`**Description**: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. ## `metric_aggregation_type`{% #metric_aggregation_type %} **Type**: `STRING`**Provider name**: `MetricAggregationType`**Description**: The aggregation type for the CloudWatch metrics. The valid values are `Minimum`, `Maximum`, and `Average`. ## `min_adjustment_magnitude`{% #min_adjustment_magnitude %} **Type**: `INT32`**Provider name**: `MinAdjustmentMagnitude`**Description**: The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`. ## `min_adjustment_step`{% #min_adjustment_step %} **Type**: `INT32`**Provider name**: `MinAdjustmentStep`**Description**: Available for backward compatibility. Use `MinAdjustmentMagnitude` instead. ## `policy_arn`{% #policy_arn %} **Type**: `STRING`**Provider name**: `PolicyARN`**Description**: The Amazon Resource Name (ARN) of the policy. ## `policy_name`{% #policy_name %} **Type**: `STRING`**Provider name**: `PolicyName`**Description**: The name of the scaling policy. ## `policy_type`{% #policy_type %} **Type**: `STRING`**Provider name**: `PolicyType`**Description**: One of the following policy types: - `TargetTrackingScaling` - `StepScaling` - `SimpleScaling` (default) - `PredictiveScaling` For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) and [Step and simple scaling policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) in the Amazon EC2 Auto Scaling User Guide. ## `predictive_scaling_configuration`{% #predictive_scaling_configuration %} **Type**: `STRUCT`**Provider name**: `PredictiveScalingConfiguration`**Description**: A predictive scaling policy. - `max_capacity_breach_behavior`**Type**: `STRING`**Provider name**: `MaxCapacityBreachBehavior`**Description**: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified. The following are possible values: - `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. - `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer`. Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum. - `max_capacity_buffer`**Type**: `INT32`**Provider name**: `MaxCapacityBuffer`**Description**: The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity. Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity`, and cannot be used otherwise. - `metric_specifications`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `MetricSpecifications`**Description**: This structure includes the metrics and target utilization to use for predictive scaling. This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric. - `customized_capacity_metric_specification`**Type**: `STRUCT`**Provider name**: `CustomizedCapacityMetricSpecification`**Description**: The customized capacity metric specification. - `metric_data_queries`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `MetricDataQueries`**Description**: One or more metric data queries to provide the data points for a capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data. - `expression`**Type**: `STRING`**Provider name**: `Expression`**Description**: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `id`**Type**: `STRING`**Provider name**: `Id`**Description**: A short name that identifies the object's results in the response. This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. - `label`**Type**: `STRING`**Provider name**: `Label`**Description**: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - `metric_stat`**Type**: `STRUCT`**Provider name**: `MetricStat`**Description**: Information about the metric data to return. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `metric`**Type**: `STRUCT`**Provider name**: `Metric`**Description**: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. - `stat`**Type**: `STRING`**Provider name**: `Stat`**Description**: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the Amazon CloudWatch User Guide. The most commonly used metrics for predictive scaling are `Average` and `Sum`. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `return_data`**Type**: `BOOLEAN`**Provider name**: `ReturnData`**Description**: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData`. This sets it to its default (`true`). - `customized_load_metric_specification`**Type**: `STRUCT`**Provider name**: `CustomizedLoadMetricSpecification`**Description**: The customized load metric specification. - `metric_data_queries`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `MetricDataQueries`**Description**: One or more metric data queries to provide the data points for a load metric. Use multiple metric data queries only if you are performing a math expression on returned data. - `expression`**Type**: `STRING`**Provider name**: `Expression`**Description**: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `id`**Type**: `STRING`**Provider name**: `Id`**Description**: A short name that identifies the object's results in the response. This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. - `label`**Type**: `STRING`**Provider name**: `Label`**Description**: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - `metric_stat`**Type**: `STRUCT`**Provider name**: `MetricStat`**Description**: Information about the metric data to return. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `metric`**Type**: `STRUCT`**Provider name**: `Metric`**Description**: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. - `stat`**Type**: `STRING`**Provider name**: `Stat`**Description**: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the Amazon CloudWatch User Guide. The most commonly used metrics for predictive scaling are `Average` and `Sum`. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `return_data`**Type**: `BOOLEAN`**Provider name**: `ReturnData`**Description**: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData`. This sets it to its default (`true`). - `customized_scaling_metric_specification`**Type**: `STRUCT`**Provider name**: `CustomizedScalingMetricSpecification`**Description**: The customized scaling metric specification. - `metric_data_queries`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `MetricDataQueries`**Description**: One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data. - `expression`**Type**: `STRING`**Provider name**: `Expression`**Description**: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `id`**Type**: `STRING`**Provider name**: `Id`**Description**: A short name that identifies the object's results in the response. This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. - `label`**Type**: `STRING`**Provider name**: `Label`**Description**: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - `metric_stat`**Type**: `STRUCT`**Provider name**: `MetricStat`**Description**: Information about the metric data to return. Conditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `metric`**Type**: `STRUCT`**Provider name**: `Metric`**Description**: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. - `stat`**Type**: `STRING`**Provider name**: `Stat`**Description**: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the Amazon CloudWatch User Guide. The most commonly used metrics for predictive scaling are `Average` and `Sum`. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `return_data`**Type**: `BOOLEAN`**Provider name**: `ReturnData`**Description**: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData`. This sets it to its default (`true`). - `predefined_load_metric_specification`**Type**: `STRUCT`**Provider name**: `PredefinedLoadMetricSpecification`**Description**: The predefined load metric specification. - `predefined_metric_type`**Type**: `STRING`**Provider name**: `PredefinedMetricType`**Description**: The metric type. - `resource_label`**Type**: `STRING`**Provider name**: `ResourceLabel`**Description**: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`. Where: - app// is the final portion of the load balancer ARN - targetgroup// is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. - `predefined_metric_pair_specification`**Type**: `STRUCT`**Provider name**: `PredefinedMetricPairSpecification`**Description**: The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use. - `predefined_metric_type`**Type**: `STRING`**Provider name**: `PredefinedMetricType`**Description**: Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is `ASGCPUUtilization`, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric. - `resource_label`**Type**: `STRING`**Provider name**: `ResourceLabel`**Description**: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`. Where: - app// is the final portion of the load balancer ARN - targetgroup// is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. - `predefined_scaling_metric_specification`**Type**: `STRUCT`**Provider name**: `PredefinedScalingMetricSpecification`**Description**: The predefined scaling metric specification. - `predefined_metric_type`**Type**: `STRING`**Provider name**: `PredefinedMetricType`**Description**: The metric type. - `resource_label`**Type**: `STRING`**Provider name**: `ResourceLabel`**Description**: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`. Where: - app// is the final portion of the load balancer ARN - targetgroup// is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. - `target_value`**Type**: `DOUBLE`**Provider name**: `TargetValue`**Description**: Specifies the target utilization.Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval. - `mode`**Type**: `STRING`**Provider name**: `Mode`**Description**: The predictive scaling mode. Defaults to `ForecastOnly` if not specified. - `scheduling_buffer_time`**Type**: `INT32`**Provider name**: `SchedulingBufferTime`**Description**: The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. ## `scaling_adjustment`{% #scaling_adjustment %} **Type**: `INT32`**Provider name**: `ScalingAdjustment`**Description**: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. ## `step_adjustments`{% #step_adjustments %} **Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `StepAdjustments`**Description**: A set of adjustments that enable you to scale based on the size of the alarm breach. - `metric_interval_lower_bound`**Type**: `DOUBLE`**Provider name**: `MetricIntervalLowerBound`**Description**: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. - `metric_interval_upper_bound`**Type**: `DOUBLE`**Provider name**: `MetricIntervalUpperBound`**Description**: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound. - `scaling_adjustment`**Type**: `INT32`**Provider name**: `ScalingAdjustment`**Description**: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `target_tracking_configuration`{% #target_tracking_configuration %} **Type**: `STRUCT`**Provider name**: `TargetTrackingConfiguration`**Description**: A target tracking scaling policy. - `customized_metric_specification`**Type**: `STRUCT`**Provider name**: `CustomizedMetricSpecification`**Description**: A customized metric. You must specify either a predefined metric or a customized metric. - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). - `metrics`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Metrics`**Description**: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. - `expression`**Type**: `STRING`**Provider name**: `Expression`**Description**: The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `id`**Type**: `STRING`**Provider name**: `Id`**Description**: A short name that identifies the object's results in the response. This name must be unique among all `TargetTrackingMetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. - `label`**Type**: `STRING`**Provider name**: `Label`**Description**: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. - `metric_stat`**Type**: `STRUCT`**Provider name**: `MetricStat`**Description**: Information about the metric data to return. Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat`, but not both. - `metric`**Type**: `STRUCT`**Provider name**: `Metric`**Description**: The metric to use. - `dimensions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Dimensions`**Description**: The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the dimension. - `value`**Type**: `STRING`**Provider name**: `Value`**Description**: The value of the dimension. - `metric_name`**Type**: `STRING`**Provider name**: `MetricName`**Description**: The name of the metric. - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)in the Amazon CloudWatch User Guide. - `period`**Type**: `INT32`**Provider name**: `Period`**Description**: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html). - `stat`**Type**: `STRING`**Provider name**: `Stat`**Description**: The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is `Average`. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `period`**Type**: `INT32`**Provider name**: `Period`**Description**: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html). - `return_data`**Type**: `BOOLEAN`**Provider name**: `ReturnData`**Description**: Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData`. This sets it to its default (`true`). - `namespace`**Type**: `STRING`**Provider name**: `Namespace`**Description**: The namespace of the metric. - `period`**Type**: `INT32`**Provider name**: `Period`**Description**: The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html). - `statistic`**Type**: `STRING`**Provider name**: `Statistic`**Description**: The statistic of the metric. - `unit`**Type**: `STRING`**Provider name**: `Unit`**Description**: The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the Amazon CloudWatch API Reference. - `disable_scale_in`**Type**: `BOOLEAN`**Provider name**: `DisableScaleIn`**Description**: Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is `false`. - `predefined_metric_specification`**Type**: `STRUCT`**Provider name**: `PredefinedMetricSpecification`**Description**: A predefined metric. You must specify either a predefined metric or a customized metric. - `predefined_metric_type`**Type**: `STRING`**Provider name**: `PredefinedMetricType`**Description**: The metric type. The following predefined metrics are available: - `ASGAverageCPUUtilization` - Average CPU utilization of the Auto Scaling group. - `ASGAverageNetworkIn` - Average number of bytes received on all network interfaces by the Auto Scaling group. - `ASGAverageNetworkOut` - Average number of bytes sent out on all network interfaces by the Auto Scaling group. - `ALBRequestCountPerTarget` - Average Application Load Balancer request count per target for your Auto Scaling group. - `resource_label`**Type**: `STRING`**Provider name**: `ResourceLabel`**Description**: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`. Where: - app// is the final portion of the load balancer ARN - targetgroup// is the final portion of the target group ARN. To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation. - `target_value`**Type**: `DOUBLE`**Provider name**: `TargetValue`**Description**: The target value for the metric.Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.