We recommend new projects start with resources from the AWS provider.
aws-native.autoscaling.ScalingPolicy
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
Create ScalingPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScalingPolicy(name: string, args: ScalingPolicyArgs, opts?: CustomResourceOptions);
@overload
def ScalingPolicy(resource_name: str,
args: ScalingPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScalingPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_scaling_group_name: Optional[str] = None,
adjustment_type: Optional[str] = None,
cooldown: Optional[str] = None,
estimated_instance_warmup: Optional[int] = None,
metric_aggregation_type: Optional[str] = None,
min_adjustment_magnitude: Optional[int] = None,
policy_type: Optional[str] = None,
predictive_scaling_configuration: Optional[ScalingPolicyPredictiveScalingConfigurationArgs] = None,
scaling_adjustment: Optional[int] = None,
step_adjustments: Optional[Sequence[ScalingPolicyStepAdjustmentArgs]] = None,
target_tracking_configuration: Optional[ScalingPolicyTargetTrackingConfigurationArgs] = None)
func NewScalingPolicy(ctx *Context, name string, args ScalingPolicyArgs, opts ...ResourceOption) (*ScalingPolicy, error)
public ScalingPolicy(string name, ScalingPolicyArgs args, CustomResourceOptions? opts = null)
public ScalingPolicy(String name, ScalingPolicyArgs args)
public ScalingPolicy(String name, ScalingPolicyArgs args, CustomResourceOptions options)
type: aws-native:autoscaling:ScalingPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ScalingPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScalingPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScalingPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScalingPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScalingPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ScalingPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScalingPolicy resource accepts the following input properties:
- Auto
Scaling stringGroup Name - The name of the Auto Scaling group.
- Adjustment
Type string - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- Cooldown string
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- Estimated
Instance intWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- Metric
Aggregation stringType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- Min
Adjustment intMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- Policy
Type string - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- Predictive
Scaling Pulumi.Configuration Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Configuration - A predictive scaling policy. Includes support for predefined metrics only.
- Scaling
Adjustment int - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- Step
Adjustments List<Pulumi.Aws Native. Auto Scaling. Inputs. Scaling Policy Step Adjustment> - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- Target
Tracking Pulumi.Configuration Aws Native. Auto Scaling. Inputs. Scaling Policy Target Tracking Configuration - A target tracking scaling policy. Includes support for predefined or customized metrics.
- Auto
Scaling stringGroup Name - The name of the Auto Scaling group.
- Adjustment
Type string - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- Cooldown string
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- Estimated
Instance intWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- Metric
Aggregation stringType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- Min
Adjustment intMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- Policy
Type string - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- Predictive
Scaling ScalingConfiguration Policy Predictive Scaling Configuration Args - A predictive scaling policy. Includes support for predefined metrics only.
- Scaling
Adjustment int - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- Step
Adjustments []ScalingPolicy Step Adjustment Args - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- Target
Tracking ScalingConfiguration Policy Target Tracking Configuration Args - A target tracking scaling policy. Includes support for predefined or customized metrics.
- auto
Scaling StringGroup Name - The name of the Auto Scaling group.
- adjustment
Type String - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- cooldown String
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- estimated
Instance IntegerWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- metric
Aggregation StringType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- min
Adjustment IntegerMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- policy
Type String - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- predictive
Scaling ScalingConfiguration Policy Predictive Scaling Configuration - A predictive scaling policy. Includes support for predefined metrics only.
- scaling
Adjustment Integer - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- step
Adjustments List<ScalingPolicy Step Adjustment> - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- target
Tracking ScalingConfiguration Policy Target Tracking Configuration - A target tracking scaling policy. Includes support for predefined or customized metrics.
- auto
Scaling stringGroup Name - The name of the Auto Scaling group.
- adjustment
Type string - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- cooldown string
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- estimated
Instance numberWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- metric
Aggregation stringType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- min
Adjustment numberMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- policy
Type string - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- predictive
Scaling ScalingConfiguration Policy Predictive Scaling Configuration - A predictive scaling policy. Includes support for predefined metrics only.
- scaling
Adjustment number - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- step
Adjustments ScalingPolicy Step Adjustment[] - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- target
Tracking ScalingConfiguration Policy Target Tracking Configuration - A target tracking scaling policy. Includes support for predefined or customized metrics.
- auto_
scaling_ strgroup_ name - The name of the Auto Scaling group.
- adjustment_
type str - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- cooldown str
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- estimated_
instance_ intwarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- metric_
aggregation_ strtype - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- min_
adjustment_ intmagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- policy_
type str - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- predictive_
scaling_ Scalingconfiguration Policy Predictive Scaling Configuration Args - A predictive scaling policy. Includes support for predefined metrics only.
- scaling_
adjustment int - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- step_
adjustments Sequence[ScalingPolicy Step Adjustment Args] - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- target_
tracking_ Scalingconfiguration Policy Target Tracking Configuration Args - A target tracking scaling policy. Includes support for predefined or customized metrics.
- auto
Scaling StringGroup Name - The name of the Auto Scaling group.
- adjustment
Type String - Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- cooldown String
- The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
- estimated
Instance NumberWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling.
- metric
Aggregation StringType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
- min
Adjustment NumberMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
- policy
Type String - One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
- predictive
Scaling Property MapConfiguration - A predictive scaling policy. Includes support for predefined metrics only.
- scaling
Adjustment Number - 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 positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)
- step
Adjustments List<Property Map> - A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)
- target
Tracking Property MapConfiguration - A target tracking scaling policy. Includes support for predefined or customized metrics.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScalingPolicy resource produces the following output properties:
- Arn string
- The ARN of the AutoScaling scaling policy
- Id string
- The provider-assigned unique ID for this managed resource.
- Policy
Name string - Returns the name of a scaling policy.
- Arn string
- The ARN of the AutoScaling scaling policy
- Id string
- The provider-assigned unique ID for this managed resource.
- Policy
Name string - Returns the name of a scaling policy.
- arn String
- The ARN of the AutoScaling scaling policy
- id String
- The provider-assigned unique ID for this managed resource.
- policy
Name String - Returns the name of a scaling policy.
- arn string
- The ARN of the AutoScaling scaling policy
- id string
- The provider-assigned unique ID for this managed resource.
- policy
Name string - Returns the name of a scaling policy.
- arn str
- The ARN of the AutoScaling scaling policy
- id str
- The provider-assigned unique ID for this managed resource.
- policy_
name str - Returns the name of a scaling policy.
- arn String
- The ARN of the AutoScaling scaling policy
- id String
- The provider-assigned unique ID for this managed resource.
- policy
Name String - Returns the name of a scaling policy.
Supporting Types
ScalingPolicyCustomizedMetricSpecification, ScalingPolicyCustomizedMetricSpecificationArgs
- Dimensions
List<Pulumi.
Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Dimension> The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- Metric
Name string - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- Metrics
List<Pulumi.
Aws Native. Auto Scaling. Inputs. Scaling Policy Target Tracking Metric Data Query> - 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.
- Namespace string
- The namespace of the metric.
- Statistic string
- The statistic of the metric.
- Unit string
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- Dimensions
[]Scaling
Policy Metric Dimension The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- Metric
Name string - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- Metrics
[]Scaling
Policy Target Tracking Metric Data Query - 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.
- Namespace string
- The namespace of the metric.
- Statistic string
- The statistic of the metric.
- Unit string
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- dimensions
List<Scaling
Policy Metric Dimension> The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name String - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- metrics
List<Scaling
Policy Target Tracking Metric Data Query> - 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.
- namespace String
- The namespace of the metric.
- statistic String
- The statistic of the metric.
- unit String
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- dimensions
Scaling
Policy Metric Dimension[] The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name string - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- metrics
Scaling
Policy Target Tracking Metric Data Query[] - 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.
- namespace string
- The namespace of the metric.
- statistic string
- The statistic of the metric.
- unit string
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- dimensions
Sequence[Scaling
Policy Metric Dimension] The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric_
name str - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- metrics
Sequence[Scaling
Policy Target Tracking Metric Data Query] - 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.
- namespace str
- The namespace of the metric.
- statistic str
- The statistic of the metric.
- unit str
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- dimensions List<Property Map>
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name String - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- metrics List<Property Map>
- 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.
- namespace String
- The namespace of the metric.
- statistic String
- The statistic of the metric.
- unit String
- The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
ScalingPolicyMetric, ScalingPolicyMetricArgs
- Metric
Name string - The name of the metric.
- Namespace string
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- Dimensions
List<Pulumi.
Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Dimension> The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- Metric
Name string - The name of the metric.
- Namespace string
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- Dimensions
[]Scaling
Policy Metric Dimension The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name String - The name of the metric.
- namespace String
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- dimensions
List<Scaling
Policy Metric Dimension> The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name string - The name of the metric.
- namespace string
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- dimensions
Scaling
Policy Metric Dimension[] The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric_
name str - The name of the metric.
- namespace str
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- dimensions
Sequence[Scaling
Policy Metric Dimension] The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
- metric
Name String - The name of the metric.
- namespace String
- The namespace of the metric. For more information, see the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
- dimensions List<Property Map>
The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in AWS services that publish CloudWatch metrics in the Amazon CloudWatch User Guide .
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
ScalingPolicyMetricDataQuery, ScalingPolicyMetricDataQueryArgs
- Id string
- 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. - Expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Label string
- 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 Pulumi.Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Stat Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Return
Data bool 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 specifyfalse
forReturnData
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
).
- Id string
- 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. - Expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Label string
- 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 ScalingPolicy Metric Stat Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Return
Data bool 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 specifyfalse
forReturnData
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
).
- id String
- 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. - expression String
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label String
- 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 ScalingPolicy Metric Stat Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data Boolean 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 specifyfalse
forReturnData
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
).
- id string
- 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. - expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label string
- 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 ScalingPolicy Metric Stat Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data boolean 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 specifyfalse
forReturnData
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
).
- id str
- 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. - expression str
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label str
- 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 ScalingPolicy Metric Stat Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return_
data bool 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 specifyfalse
forReturnData
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
).
- id String
- 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. - expression String
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label String
- 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 Property Map Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data Boolean 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 specifyfalse
forReturnData
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
).
ScalingPolicyMetricDimension, ScalingPolicyMetricDimensionArgs
ScalingPolicyMetricStat, ScalingPolicyMetricStatArgs
- Metric
Pulumi.
Aws Native. Auto Scaling. Inputs. Scaling Policy Metric - The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- Stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- Unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- Metric
Scaling
Policy Metric - The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- Stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- Unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- stat String
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- unit String
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- stat str
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- unit str
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric Property Map
- The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics .
- stat String
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metrics for predictive scaling are
Average
andSum
.- unit String
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
ScalingPolicyPredefinedMetricSpecification, ScalingPolicyPredefinedMetricSpecificationArgs
- Predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- Predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - 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 String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined_
metric_ strtype - 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 str 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - 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 String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
ScalingPolicyPredictiveScalingConfiguration, ScalingPolicyPredictiveScalingConfigurationArgs
- Metric
Specifications List<Pulumi.Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Metric Specification> 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.
- Max
Capacity stringBreach Behavior 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 forMaxCapacityBuffer
.
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 intBuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- Mode string
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - Scheduling
Buffer intTime 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.
- Metric
Specifications []ScalingPolicy Predictive Scaling Metric Specification 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.
- Max
Capacity stringBreach Behavior 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 forMaxCapacityBuffer
.
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 intBuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- Mode string
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - Scheduling
Buffer intTime 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.
- metric
Specifications List<ScalingPolicy Predictive Scaling Metric Specification> 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.
- max
Capacity StringBreach Behavior 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 forMaxCapacityBuffer
.
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 IntegerBuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- mode String
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - scheduling
Buffer IntegerTime 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.
- metric
Specifications ScalingPolicy Predictive Scaling Metric Specification[] 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.
- max
Capacity stringBreach Behavior 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 forMaxCapacityBuffer
.
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 numberBuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- mode string
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - scheduling
Buffer numberTime 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.
- metric_
specifications Sequence[ScalingPolicy Predictive Scaling Metric Specification] 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.
- max_
capacity_ strbreach_ behavior 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 forMaxCapacityBuffer
.
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_ intbuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- mode str
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - scheduling_
buffer_ inttime 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.
- metric
Specifications List<Property Map> 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.
- max
Capacity StringBreach Behavior 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 forMaxCapacityBuffer
.
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 NumberBuffer 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 toIncreaseMaxCapacity
, and cannot be used otherwise.- mode String
- The predictive scaling mode. Defaults to
ForecastOnly
if not specified. - scheduling
Buffer NumberTime 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.
ScalingPolicyPredictiveScalingCustomizedCapacityMetric, ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs
- Metric
Data List<Pulumi.Queries Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Data Query> - 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.
- Metric
Data []ScalingQueries Policy Metric Data Query - 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.
- metric
Data List<ScalingQueries Policy Metric Data Query> - 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.
- metric
Data ScalingQueries Policy Metric Data Query[] - 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.
- metric_
data_ Sequence[Scalingqueries Policy Metric Data Query] - 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.
- metric
Data List<Property Map>Queries - 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.
ScalingPolicyPredictiveScalingCustomizedLoadMetric, ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs
- Metric
Data List<Pulumi.Queries Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Data Query> - 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.
- Metric
Data []ScalingQueries Policy Metric Data Query - 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.
- metric
Data List<ScalingQueries Policy Metric Data Query> - 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.
- metric
Data ScalingQueries Policy Metric Data Query[] - 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.
- metric_
data_ Sequence[Scalingqueries Policy Metric Data Query] - 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.
- metric
Data List<Property Map>Queries - 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.
ScalingPolicyPredictiveScalingCustomizedScalingMetric, ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs
- Metric
Data List<Pulumi.Queries Aws Native. Auto Scaling. Inputs. Scaling Policy Metric Data Query> - 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.
- Metric
Data []ScalingQueries Policy Metric Data Query - 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.
- metric
Data List<ScalingQueries Policy Metric Data Query> - 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.
- metric
Data ScalingQueries Policy Metric Data Query[] - 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.
- metric_
data_ Sequence[Scalingqueries Policy Metric Data Query] - 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.
- metric
Data List<Property Map>Queries - 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.
ScalingPolicyPredictiveScalingMetricSpecification, ScalingPolicyPredictiveScalingMetricSpecificationArgs
- Target
Value double 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.
- Customized
Capacity Pulumi.Metric Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Customized Capacity Metric - The customized capacity metric specification.
- Customized
Load Pulumi.Metric Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Customized Load Metric - The customized load metric specification.
- Customized
Scaling Pulumi.Metric Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Customized Scaling Metric - The customized scaling metric specification.
- Predefined
Load Pulumi.Metric Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Predefined Load Metric - The predefined load metric specification.
- Predefined
Metric Pulumi.Pair Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Predefined Metric Pair - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- Predefined
Scaling Pulumi.Metric Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predictive Scaling Predefined Scaling Metric - The predefined scaling metric specification.
- Target
Value float64 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.
- Customized
Capacity ScalingMetric Specification Policy Predictive Scaling Customized Capacity Metric - The customized capacity metric specification.
- Customized
Load ScalingMetric Specification Policy Predictive Scaling Customized Load Metric - The customized load metric specification.
- Customized
Scaling ScalingMetric Specification Policy Predictive Scaling Customized Scaling Metric - The customized scaling metric specification.
- Predefined
Load ScalingMetric Specification Policy Predictive Scaling Predefined Load Metric - The predefined load metric specification.
- Predefined
Metric ScalingPair Specification Policy Predictive Scaling Predefined Metric Pair - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- Predefined
Scaling ScalingMetric Specification Policy Predictive Scaling Predefined Scaling Metric - The predefined scaling metric specification.
- target
Value Double 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.
- customized
Capacity ScalingMetric Specification Policy Predictive Scaling Customized Capacity Metric - The customized capacity metric specification.
- customized
Load ScalingMetric Specification Policy Predictive Scaling Customized Load Metric - The customized load metric specification.
- customized
Scaling ScalingMetric Specification Policy Predictive Scaling Customized Scaling Metric - The customized scaling metric specification.
- predefined
Load ScalingMetric Specification Policy Predictive Scaling Predefined Load Metric - The predefined load metric specification.
- predefined
Metric ScalingPair Specification Policy Predictive Scaling Predefined Metric Pair - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- predefined
Scaling ScalingMetric Specification Policy Predictive Scaling Predefined Scaling Metric - The predefined scaling metric specification.
- target
Value number 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.
- customized
Capacity ScalingMetric Specification Policy Predictive Scaling Customized Capacity Metric - The customized capacity metric specification.
- customized
Load ScalingMetric Specification Policy Predictive Scaling Customized Load Metric - The customized load metric specification.
- customized
Scaling ScalingMetric Specification Policy Predictive Scaling Customized Scaling Metric - The customized scaling metric specification.
- predefined
Load ScalingMetric Specification Policy Predictive Scaling Predefined Load Metric - The predefined load metric specification.
- predefined
Metric ScalingPair Specification Policy Predictive Scaling Predefined Metric Pair - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- predefined
Scaling ScalingMetric Specification Policy Predictive Scaling Predefined Scaling Metric - The predefined scaling metric specification.
- target_
value float 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.
- customized_
capacity_ Scalingmetric_ specification Policy Predictive Scaling Customized Capacity Metric - The customized capacity metric specification.
- customized_
load_ Scalingmetric_ specification Policy Predictive Scaling Customized Load Metric - The customized load metric specification.
- customized_
scaling_ Scalingmetric_ specification Policy Predictive Scaling Customized Scaling Metric - The customized scaling metric specification.
- predefined_
load_ Scalingmetric_ specification Policy Predictive Scaling Predefined Load Metric - The predefined load metric specification.
- predefined_
metric_ Scalingpair_ specification Policy Predictive Scaling Predefined Metric Pair - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- predefined_
scaling_ Scalingmetric_ specification Policy Predictive Scaling Predefined Scaling Metric - The predefined scaling metric specification.
- target
Value Number 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.
- customized
Capacity Property MapMetric Specification - The customized capacity metric specification.
- customized
Load Property MapMetric Specification - The customized load metric specification.
- customized
Scaling Property MapMetric Specification - The customized scaling metric specification.
- predefined
Load Property MapMetric Specification - The predefined load metric specification.
- predefined
Metric Property MapPair Specification - The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
- predefined
Scaling Property MapMetric Specification - The predefined scaling metric specification.
ScalingPolicyPredictiveScalingPredefinedLoadMetric, ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs
- Predefined
Metric stringType - The metric type.
- Resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- Predefined
Metric stringType - The metric type.
- Resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - The metric type.
- resource
Label String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric stringType - The metric type.
- resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined_
metric_ strtype - The metric type.
- resource_
label str 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - The metric type.
- resource
Label String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
ScalingPolicyPredictiveScalingPredefinedMetricPair, ScalingPolicyPredictiveScalingPredefinedMetricPairArgs
- Predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- Predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - 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 String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric stringType - 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 string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined_
metric_ strtype - 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 str 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - 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 String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
ScalingPolicyPredictiveScalingPredefinedScalingMetric, ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs
- Predefined
Metric stringType - The metric type.
- Resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- Predefined
Metric stringType - The metric type.
- Resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - The metric type.
- resource
Label String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric stringType - The metric type.
- resource
Label string 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined_
metric_ strtype - The metric type.
- resource_
label str 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- predefined
Metric StringType - The metric type.
- resource
Label String 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 API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
ScalingPolicyStepAdjustment, ScalingPolicyStepAdjustmentArgs
- Scaling
Adjustment int - 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.
- Metric
Interval doubleLower Bound - 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 doubleUpper Bound 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 int - 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.
- Metric
Interval float64Lower Bound - 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 float64Upper Bound 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 Integer - 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.
- metric
Interval DoubleLower Bound - 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 DoubleUpper Bound 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 number - 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.
- metric
Interval numberLower Bound - 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 numberUpper Bound 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 int - 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.
- metric_
interval_ floatlower_ bound - 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_ floatupper_ bound 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 Number - 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.
- metric
Interval NumberLower Bound - 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 NumberUpper Bound 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.
ScalingPolicyTargetTrackingConfiguration, ScalingPolicyTargetTrackingConfigurationArgs
- Target
Value double 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.
- Customized
Metric Pulumi.Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Customized Metric Specification - A customized metric. You must specify either a predefined metric or a customized metric.
- Disable
Scale boolIn - 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 Pulumi.Specification Aws Native. Auto Scaling. Inputs. Scaling Policy Predefined Metric Specification - A predefined metric. You must specify either a predefined metric or a customized metric.
- Target
Value float64 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.
- Customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You must specify either a predefined metric or a customized metric.
- Disable
Scale boolIn - 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 ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You must specify either a predefined metric or a customized metric.
- target
Value Double 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.
- customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You must specify either a predefined metric or a customized metric.
- disable
Scale BooleanIn - 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 ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You must specify either a predefined metric or a customized metric.
- target
Value number 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.
- customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You must specify either a predefined metric or a customized metric.
- disable
Scale booleanIn - 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 ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You must specify either a predefined metric or a customized metric.
- target_
value float 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.
- customized_
metric_ Scalingspecification Policy Customized Metric Specification - A customized metric. You must specify either a predefined metric or a customized metric.
- disable_
scale_ boolin - 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_ Scalingspecification Policy Predefined Metric Specification - A predefined metric. You must specify either a predefined metric or a customized metric.
- target
Value Number 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.
- customized
Metric Property MapSpecification - A customized metric. You must specify either a predefined metric or a customized metric.
- disable
Scale BooleanIn - 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 Property MapSpecification - A predefined metric. You must specify either a predefined metric or a customized metric.
ScalingPolicyTargetTrackingMetricDataQuery, ScalingPolicyTargetTrackingMetricDataQueryArgs
- Id string
- 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. - Expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Label string
- 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 Pulumi.Aws Native. Auto Scaling. Inputs. Scaling Policy Target Tracking Metric Stat Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Return
Data bool 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 specifyfalse
forReturnData
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
).
- Id string
- 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. - Expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Label string
- 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 ScalingPolicy Target Tracking Metric Stat Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- Return
Data bool 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 specifyfalse
forReturnData
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
).
- id String
- 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. - expression String
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label String
- 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 ScalingPolicy Target Tracking Metric Stat Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data Boolean 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 specifyfalse
forReturnData
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
).
- id string
- 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. - expression string
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label string
- 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 ScalingPolicy Target Tracking Metric Stat Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data boolean 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 specifyfalse
forReturnData
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
).
- id str
- 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. - expression str
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label str
- 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 ScalingPolicy Target Tracking Metric Stat Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return_
data bool 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 specifyfalse
forReturnData
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
).
- id String
- 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. - expression String
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 theId
of other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- label String
- 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 Property Map Information about the metric data to return.
Conditional: Within each
TargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both.- return
Data Boolean 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 specifyfalse
forReturnData
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
).
ScalingPolicyTargetTrackingMetricStat, ScalingPolicyTargetTrackingMetricStatArgs
- Metric
Pulumi.
Aws Native. Auto Scaling. Inputs. Scaling Policy Metric - The metric to use.
- Stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- Unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- Metric
Scaling
Policy Metric - The metric to use.
- Stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- Unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The metric to use.
- stat String
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- unit String
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The metric to use.
- stat string
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- unit string
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric
Scaling
Policy Metric - The metric to use.
- stat str
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- unit str
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
- metric Property Map
- The metric to use.
- stat String
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
The most commonly used metric for scaling is
Average
.- unit String
- The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference .
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.