1. Packages
  2. AWS Native
  3. API Docs
  4. autoscaling
  5. ScalingPolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.autoscaling.ScalingPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    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

    The ScalingPolicy resource accepts the following input properties:

    AutoScalingGroupName string
    The name of the Auto Scaling group.
    AdjustmentType 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.
    EstimatedInstanceWarmup int
    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.
    MetricAggregationType string
    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.
    MinAdjustmentMagnitude int
    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.
    PolicyType string
    One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
    PredictiveScalingConfiguration Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingConfiguration
    A predictive scaling policy. Includes support for predefined metrics only.
    ScalingAdjustment 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.)
    StepAdjustments List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyStepAdjustment>
    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.)
    TargetTrackingConfiguration Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyTargetTrackingConfiguration
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    AutoScalingGroupName string
    The name of the Auto Scaling group.
    AdjustmentType 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.
    EstimatedInstanceWarmup int
    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.
    MetricAggregationType string
    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.
    MinAdjustmentMagnitude int
    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.
    PolicyType string
    One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
    PredictiveScalingConfiguration ScalingPolicyPredictiveScalingConfigurationArgs
    A predictive scaling policy. Includes support for predefined metrics only.
    ScalingAdjustment 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.)
    StepAdjustments []ScalingPolicyStepAdjustmentArgs
    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.)
    TargetTrackingConfiguration ScalingPolicyTargetTrackingConfigurationArgs
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    autoScalingGroupName String
    The name of the Auto Scaling group.
    adjustmentType 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.
    estimatedInstanceWarmup Integer
    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.
    metricAggregationType String
    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.
    minAdjustmentMagnitude Integer
    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.
    policyType String
    One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
    predictiveScalingConfiguration ScalingPolicyPredictiveScalingConfiguration
    A predictive scaling policy. Includes support for predefined metrics only.
    scalingAdjustment 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.)
    stepAdjustments List<ScalingPolicyStepAdjustment>
    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.)
    targetTrackingConfiguration ScalingPolicyTargetTrackingConfiguration
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    autoScalingGroupName string
    The name of the Auto Scaling group.
    adjustmentType 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.
    estimatedInstanceWarmup number
    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.
    metricAggregationType string
    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.
    minAdjustmentMagnitude number
    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.
    policyType string
    One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
    predictiveScalingConfiguration ScalingPolicyPredictiveScalingConfiguration
    A predictive scaling policy. Includes support for predefined metrics only.
    scalingAdjustment 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.)
    stepAdjustments ScalingPolicyStepAdjustment[]
    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.)
    targetTrackingConfiguration ScalingPolicyTargetTrackingConfiguration
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    auto_scaling_group_name str
    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_warmup int
    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_type str
    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_magnitude int
    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_configuration ScalingPolicyPredictiveScalingConfigurationArgs
    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[ScalingPolicyStepAdjustmentArgs]
    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_configuration ScalingPolicyTargetTrackingConfigurationArgs
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    autoScalingGroupName String
    The name of the Auto Scaling group.
    adjustmentType 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.
    estimatedInstanceWarmup Number
    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.
    metricAggregationType String
    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.
    minAdjustmentMagnitude Number
    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.
    policyType String
    One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling
    predictiveScalingConfiguration Property Map
    A predictive scaling policy. Includes support for predefined metrics only.
    scalingAdjustment 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.)
    stepAdjustments 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.)
    targetTrackingConfiguration Property Map
    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.
    PolicyName 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.
    PolicyName 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.
    policyName 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.
    policyName 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.
    policyName String
    Returns the name of a scaling policy.

    Supporting Types

    ScalingPolicyCustomizedMetricSpecification, ScalingPolicyCustomizedMetricSpecificationArgs

    Dimensions List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricDimension>

    The dimensions of the metric.

    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

    MetricName 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.AwsNative.AutoScaling.Inputs.ScalingPolicyTargetTrackingMetricDataQuery>
    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 []ScalingPolicyMetricDimension

    The dimensions of the metric.

    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

    MetricName 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 []ScalingPolicyTargetTrackingMetricDataQuery
    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<ScalingPolicyMetricDimension>

    The dimensions of the metric.

    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

    metricName 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<ScalingPolicyTargetTrackingMetricDataQuery>
    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 ScalingPolicyMetricDimension[]

    The dimensions of the metric.

    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

    metricName 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 ScalingPolicyTargetTrackingMetricDataQuery[]
    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[ScalingPolicyMetricDimension]

    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[ScalingPolicyTargetTrackingMetricDataQuery]
    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.

    metricName 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

    MetricName 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.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricDimension>

    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.

    MetricName 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 []ScalingPolicyMetricDimension

    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.

    metricName 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<ScalingPolicyMetricDimension>

    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.

    metricName 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 ScalingPolicyMetricDimension[]

    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[ScalingPolicyMetricDimension]

    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.

    metricName 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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    MetricStat Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    ReturnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    MetricStat ScalingPolicyMetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    ReturnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat ScalingPolicyMetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat ScalingPolicyMetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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 ScalingPolicyMetricStat

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat Property Map

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    ScalingPolicyMetricDimension, ScalingPolicyMetricDimensionArgs

    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.
    name string
    The name of the dimension.
    value string
    The value of the dimension.
    name str
    The name of the dimension.
    value str
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.

    ScalingPolicyMetricStat, ScalingPolicyMetricStatArgs

    Metric Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetric
    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 and Sum .

    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 ScalingPolicyMetric
    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 and Sum .

    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 ScalingPolicyMetric
    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 and Sum .

    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 ScalingPolicyMetric
    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 and Sum .

    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 ScalingPolicyMetric
    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 and Sum .

    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 and Sum .

    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

    PredefinedMetricType string
    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.
    ResourceLabel 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.

    PredefinedMetricType string
    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.
    ResourceLabel 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.

    predefinedMetricType String
    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.
    resourceLabel 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.

    predefinedMetricType string
    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.
    resourceLabel 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_type str
    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.

    predefinedMetricType String
    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.
    resourceLabel 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

    MetricSpecifications List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingMetricSpecification>

    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.

    MaxCapacityBreachBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    MaxCapacityBuffer int

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    Mode string
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    SchedulingBufferTime int

    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.

    MetricSpecifications []ScalingPolicyPredictiveScalingMetricSpecification

    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.

    MaxCapacityBreachBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    MaxCapacityBuffer int

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    Mode string
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    SchedulingBufferTime int

    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.

    metricSpecifications List<ScalingPolicyPredictiveScalingMetricSpecification>

    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.

    maxCapacityBreachBehavior String

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    maxCapacityBuffer Integer

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    mode String
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    schedulingBufferTime Integer

    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.

    metricSpecifications ScalingPolicyPredictiveScalingMetricSpecification[]

    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.

    maxCapacityBreachBehavior string

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    maxCapacityBuffer number

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    mode string
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    schedulingBufferTime number

    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[ScalingPolicyPredictiveScalingMetricSpecification]

    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_breach_behavior str

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    max_capacity_buffer int

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    mode str
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    scheduling_buffer_time int

    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.

    metricSpecifications 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.

    maxCapacityBreachBehavior String

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.

    The following are possible values:

    • HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
    • IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for MaxCapacityBuffer .

    Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.

    maxCapacityBuffer Number

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity , and cannot be used otherwise.

    mode String
    The predictive scaling mode. Defaults to ForecastOnly if not specified.
    schedulingBufferTime Number

    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

    MetricDataQueries List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricDataQuery>
    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.
    MetricDataQueries []ScalingPolicyMetricDataQuery
    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.
    metricDataQueries List<ScalingPolicyMetricDataQuery>
    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.
    metricDataQueries ScalingPolicyMetricDataQuery[]
    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_queries Sequence[ScalingPolicyMetricDataQuery]
    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.
    metricDataQueries List<Property Map>
    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

    MetricDataQueries List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricDataQuery>
    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.
    MetricDataQueries []ScalingPolicyMetricDataQuery
    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.
    metricDataQueries List<ScalingPolicyMetricDataQuery>
    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.
    metricDataQueries ScalingPolicyMetricDataQuery[]
    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_queries Sequence[ScalingPolicyMetricDataQuery]
    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.
    metricDataQueries List<Property Map>
    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

    MetricDataQueries List<Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetricDataQuery>
    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.
    MetricDataQueries []ScalingPolicyMetricDataQuery
    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.
    metricDataQueries List<ScalingPolicyMetricDataQuery>
    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.
    metricDataQueries ScalingPolicyMetricDataQuery[]
    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_queries Sequence[ScalingPolicyMetricDataQuery]
    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.
    metricDataQueries List<Property Map>
    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

    TargetValue 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.

    CustomizedCapacityMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingCustomizedCapacityMetric
    The customized capacity metric specification.
    CustomizedLoadMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingCustomizedLoadMetric
    The customized load metric specification.
    CustomizedScalingMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingCustomizedScalingMetric
    The customized scaling metric specification.
    PredefinedLoadMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingPredefinedLoadMetric
    The predefined load metric specification.
    PredefinedMetricPairSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingPredefinedMetricPair
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    PredefinedScalingMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredictiveScalingPredefinedScalingMetric
    The predefined scaling metric specification.
    TargetValue 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.

    CustomizedCapacityMetricSpecification ScalingPolicyPredictiveScalingCustomizedCapacityMetric
    The customized capacity metric specification.
    CustomizedLoadMetricSpecification ScalingPolicyPredictiveScalingCustomizedLoadMetric
    The customized load metric specification.
    CustomizedScalingMetricSpecification ScalingPolicyPredictiveScalingCustomizedScalingMetric
    The customized scaling metric specification.
    PredefinedLoadMetricSpecification ScalingPolicyPredictiveScalingPredefinedLoadMetric
    The predefined load metric specification.
    PredefinedMetricPairSpecification ScalingPolicyPredictiveScalingPredefinedMetricPair
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    PredefinedScalingMetricSpecification ScalingPolicyPredictiveScalingPredefinedScalingMetric
    The predefined scaling metric specification.
    targetValue 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.

    customizedCapacityMetricSpecification ScalingPolicyPredictiveScalingCustomizedCapacityMetric
    The customized capacity metric specification.
    customizedLoadMetricSpecification ScalingPolicyPredictiveScalingCustomizedLoadMetric
    The customized load metric specification.
    customizedScalingMetricSpecification ScalingPolicyPredictiveScalingCustomizedScalingMetric
    The customized scaling metric specification.
    predefinedLoadMetricSpecification ScalingPolicyPredictiveScalingPredefinedLoadMetric
    The predefined load metric specification.
    predefinedMetricPairSpecification ScalingPolicyPredictiveScalingPredefinedMetricPair
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    predefinedScalingMetricSpecification ScalingPolicyPredictiveScalingPredefinedScalingMetric
    The predefined scaling metric specification.
    targetValue 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.

    customizedCapacityMetricSpecification ScalingPolicyPredictiveScalingCustomizedCapacityMetric
    The customized capacity metric specification.
    customizedLoadMetricSpecification ScalingPolicyPredictiveScalingCustomizedLoadMetric
    The customized load metric specification.
    customizedScalingMetricSpecification ScalingPolicyPredictiveScalingCustomizedScalingMetric
    The customized scaling metric specification.
    predefinedLoadMetricSpecification ScalingPolicyPredictiveScalingPredefinedLoadMetric
    The predefined load metric specification.
    predefinedMetricPairSpecification ScalingPolicyPredictiveScalingPredefinedMetricPair
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    predefinedScalingMetricSpecification ScalingPolicyPredictiveScalingPredefinedScalingMetric
    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_metric_specification ScalingPolicyPredictiveScalingCustomizedCapacityMetric
    The customized capacity metric specification.
    customized_load_metric_specification ScalingPolicyPredictiveScalingCustomizedLoadMetric
    The customized load metric specification.
    customized_scaling_metric_specification ScalingPolicyPredictiveScalingCustomizedScalingMetric
    The customized scaling metric specification.
    predefined_load_metric_specification ScalingPolicyPredictiveScalingPredefinedLoadMetric
    The predefined load metric specification.
    predefined_metric_pair_specification ScalingPolicyPredictiveScalingPredefinedMetricPair
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    predefined_scaling_metric_specification ScalingPolicyPredictiveScalingPredefinedScalingMetric
    The predefined scaling metric specification.
    targetValue 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.

    customizedCapacityMetricSpecification Property Map
    The customized capacity metric specification.
    customizedLoadMetricSpecification Property Map
    The customized load metric specification.
    customizedScalingMetricSpecification Property Map
    The customized scaling metric specification.
    predefinedLoadMetricSpecification Property Map
    The predefined load metric specification.
    predefinedMetricPairSpecification Property Map
    The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
    predefinedScalingMetricSpecification Property Map
    The predefined scaling metric specification.

    ScalingPolicyPredictiveScalingPredefinedLoadMetric, ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs

    PredefinedMetricType string
    The metric type.
    ResourceLabel 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.

    PredefinedMetricType string
    The metric type.
    ResourceLabel 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.

    predefinedMetricType String
    The metric type.
    resourceLabel 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.

    predefinedMetricType string
    The metric type.
    resourceLabel 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_type str
    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.

    predefinedMetricType String
    The metric type.
    resourceLabel 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

    PredefinedMetricType string
    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.
    ResourceLabel 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.

    PredefinedMetricType string
    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.
    ResourceLabel 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.

    predefinedMetricType String
    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.
    resourceLabel 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.

    predefinedMetricType string
    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.
    resourceLabel 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_type str
    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.

    predefinedMetricType String
    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.
    resourceLabel 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

    PredefinedMetricType string
    The metric type.
    ResourceLabel 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.

    PredefinedMetricType string
    The metric type.
    ResourceLabel 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.

    predefinedMetricType String
    The metric type.
    resourceLabel 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.

    predefinedMetricType string
    The metric type.
    resourceLabel 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_type str
    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.

    predefinedMetricType String
    The metric type.
    resourceLabel 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

    ScalingAdjustment 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.
    MetricIntervalLowerBound double
    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.
    MetricIntervalUpperBound double

    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.

    ScalingAdjustment 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.
    MetricIntervalLowerBound float64
    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.
    MetricIntervalUpperBound float64

    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.

    scalingAdjustment 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.
    metricIntervalLowerBound Double
    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.
    metricIntervalUpperBound Double

    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.

    scalingAdjustment 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.
    metricIntervalLowerBound number
    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.
    metricIntervalUpperBound number

    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_lower_bound float
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
    metric_interval_upper_bound float

    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.

    scalingAdjustment 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.
    metricIntervalLowerBound Number
    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.
    metricIntervalUpperBound Number

    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

    TargetValue 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.

    CustomizedMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyCustomizedMetricSpecification
    A customized metric. You must specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    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 .
    PredefinedMetricSpecification Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You must specify either a predefined metric or a customized metric.
    TargetValue 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.

    CustomizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You must specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    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 .
    PredefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You must specify either a predefined metric or a customized metric.
    targetValue 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.

    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You must specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    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 .
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You must specify either a predefined metric or a customized metric.
    targetValue 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.

    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You must specify either a predefined metric or a customized metric.
    disableScaleIn boolean
    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 .
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    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_specification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You must specify either a predefined metric or a customized metric.
    disable_scale_in bool
    Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false .
    predefined_metric_specification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You must specify either a predefined metric or a customized metric.
    targetValue 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.

    customizedMetricSpecification Property Map
    A customized metric. You must specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    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 .
    predefinedMetricSpecification Property Map
    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    MetricStat Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyTargetTrackingMetricStat

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    ReturnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    MetricStat ScalingPolicyTargetTrackingMetricStat

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    ReturnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat ScalingPolicyTargetTrackingMetricStat

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat ScalingPolicyTargetTrackingMetricStat

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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 ScalingPolicyTargetTrackingMetricStat

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    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 the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    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.
    metricStat Property Map

    Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat , but not both.

    returnData 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 specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData . This sets it to its default ( true ).

    ScalingPolicyTargetTrackingMetricStat, ScalingPolicyTargetTrackingMetricStatArgs

    Metric Pulumi.AwsNative.AutoScaling.Inputs.ScalingPolicyMetric
    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 ScalingPolicyMetric
    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 ScalingPolicyMetric
    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 ScalingPolicyMetric
    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 ScalingPolicyMetric
    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi