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

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.applicationautoscaling.ScalingPolicy

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    Resource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy

    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,
                      policy_type: Optional[str] = None,
                      policy_name: Optional[str] = None,
                      resource_id: Optional[str] = None,
                      scalable_dimension: Optional[str] = None,
                      scaling_target_id: Optional[str] = None,
                      service_namespace: Optional[str] = None,
                      step_scaling_policy_configuration: Optional[ScalingPolicyStepScalingPolicyConfigurationArgs] = None,
                      target_tracking_scaling_policy_configuration: Optional[ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs] = 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:applicationautoscaling: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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const scalingPolicyResource = new aws_native.applicationautoscaling.ScalingPolicy("scalingPolicyResource", {
        policyType: "string",
        policyName: "string",
        resourceId: "string",
        scalableDimension: "string",
        scalingTargetId: "string",
        serviceNamespace: "string",
        stepScalingPolicyConfiguration: {
            adjustmentType: "string",
            cooldown: 0,
            metricAggregationType: "string",
            minAdjustmentMagnitude: 0,
            stepAdjustments: [{
                scalingAdjustment: 0,
                metricIntervalLowerBound: 0,
                metricIntervalUpperBound: 0,
            }],
        },
        targetTrackingScalingPolicyConfiguration: {
            targetValue: 0,
            customizedMetricSpecification: {
                dimensions: [{
                    name: "string",
                    value: "string",
                }],
                metricName: "string",
                metrics: [{
                    expression: "string",
                    id: "string",
                    label: "string",
                    metricStat: {
                        metric: {
                            dimensions: [{
                                name: "string",
                                value: "string",
                            }],
                            metricName: "string",
                            namespace: "string",
                        },
                        stat: "string",
                        unit: "string",
                    },
                    returnData: false,
                }],
                namespace: "string",
                statistic: "string",
                unit: "string",
            },
            disableScaleIn: false,
            predefinedMetricSpecification: {
                predefinedMetricType: "string",
                resourceLabel: "string",
            },
            scaleInCooldown: 0,
            scaleOutCooldown: 0,
        },
    });
    
    Coming soon!
    

    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:

    PolicyType string

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    PolicyName string

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    ResourceId string
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    ScalableDimension string
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    ScalingTargetId string
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    StepScalingPolicyConfiguration Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    TargetTrackingScalingPolicyConfiguration Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    PolicyType string

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    PolicyName string

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    ResourceId string
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    ScalableDimension string
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    ScalingTargetId string
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    StepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfigurationArgs
    A step scaling policy.
    TargetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs
    A target tracking scaling policy.
    policyType String

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    policyName String

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    resourceId String
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    scalableDimension String
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    scalingTargetId String
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    policyType string

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    policyName string

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    resourceId string
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    scalableDimension string
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    scalingTargetId string
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    serviceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    policy_type str

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    policy_name str

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    resource_id str
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    scalable_dimension str
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    scaling_target_id str
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    service_namespace str
    The namespace of the AWS service that provides the resource, or a custom-resource.
    step_scaling_policy_configuration ScalingPolicyStepScalingPolicyConfigurationArgs
    A step scaling policy.
    target_tracking_scaling_policy_configuration ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs
    A target tracking scaling policy.
    policyType String

    The scaling policy type.

    The following policy types are supported:

    TargetTrackingScaling Not supported for Amazon EMR

    StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

    policyName String

    The name of the scaling policy.

    Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.

    resourceId String
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    scalableDimension String
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    scalingTargetId String
    The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration Property Map
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration Property Map
    A target tracking scaling policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScalingPolicy resource produces the following output properties:

    Arn string
    ARN is a read only property for the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN is a read only property for the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN is a read only property for the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN is a read only property for the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN is a read only property for the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN is a read only property for the resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ScalingPolicyCustomizedMetricSpecification, ScalingPolicyCustomizedMetricSpecificationArgs

    Dimensions List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyMetricDimension>
    The dimensions of the metric.
    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.ApplicationAutoScaling.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.
    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.
    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.
    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.
    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.
    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.

    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.

    ScalingPolicyPredefinedMetricSpecification, ScalingPolicyPredefinedMetricSpecificationArgs

    PredefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    ResourceLabel string
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    PredefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    ResourceLabel string
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    predefinedMetricType String
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    resourceLabel String
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    predefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    resourceLabel string
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    predefined_metric_type str
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    resource_label str
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    predefinedMetricType String
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    resourceLabel String
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

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

    ScalingPolicyStepScalingPolicyConfiguration, ScalingPolicyStepScalingPolicyConfigurationArgs

    AdjustmentType string
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    Cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    MetricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    MinAdjustmentMagnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    StepAdjustments List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyStepAdjustment>
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    AdjustmentType string
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    Cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    MetricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    MinAdjustmentMagnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    StepAdjustments []ScalingPolicyStepAdjustment
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    adjustmentType String
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    cooldown Integer
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    metricAggregationType String
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    minAdjustmentMagnitude Integer
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    stepAdjustments List<ScalingPolicyStepAdjustment>
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    adjustmentType string
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    cooldown number
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    metricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    minAdjustmentMagnitude number
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    stepAdjustments ScalingPolicyStepAdjustment[]
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    adjustment_type str
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    metric_aggregation_type str
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    min_adjustment_magnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    step_adjustments Sequence[ScalingPolicyStepAdjustment]
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    adjustmentType String
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted.
    cooldown Number
    The amount of time, in seconds, to wait for a previous scaling activity to take effect.
    metricAggregationType String
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average
    minAdjustmentMagnitude Number
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
    stepAdjustments List<Property Map>
    A set of adjustments that enable you to scale based on the size of the alarm breach.

    ScalingPolicyTargetTrackingMetric, ScalingPolicyTargetTrackingMetricArgs

    Dimensions List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetricDimension>
    The dimensions for the metric.
    MetricName string
    The name of the metric.
    Namespace string
    The namespace of the metric.
    Dimensions []ScalingPolicyTargetTrackingMetricDimension
    The dimensions for the metric.
    MetricName string
    The name of the metric.
    Namespace string
    The namespace of the metric.
    dimensions List<ScalingPolicyTargetTrackingMetricDimension>
    The dimensions for the metric.
    metricName String
    The name of the metric.
    namespace String
    The namespace of the metric.
    dimensions ScalingPolicyTargetTrackingMetricDimension[]
    The dimensions for the metric.
    metricName string
    The name of the metric.
    namespace string
    The namespace of the metric.
    dimensions Sequence[ScalingPolicyTargetTrackingMetricDimension]
    The dimensions for the metric.
    metric_name str
    The name of the metric.
    namespace str
    The namespace of the metric.
    dimensions List<Property Map>
    The dimensions for the metric.
    metricName String
    The name of the metric.
    namespace String
    The namespace of the metric.

    ScalingPolicyTargetTrackingMetricDataQuery, ScalingPolicyTargetTrackingMetricDataQueryArgs

    Expression string
    The math expression to perform on the returned data, if this object is performing a math expression.
    Id string
    A short name that identifies the object's results in the response.
    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.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return.
    ReturnData bool
    Indicates whether to return the timestamps and raw data values of this metric.
    Expression string
    The math expression to perform on the returned data, if this object is performing a math expression.
    Id string
    A short name that identifies the object's results in the response.
    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.
    ReturnData bool
    Indicates whether to return the timestamps and raw data values of this metric.
    expression String
    The math expression to perform on the returned data, if this object is performing a math expression.
    id String
    A short name that identifies the object's results in the response.
    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.
    returnData Boolean
    Indicates whether to return the timestamps and raw data values of this metric.
    expression string
    The math expression to perform on the returned data, if this object is performing a math expression.
    id string
    A short name that identifies the object's results in the response.
    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.
    returnData boolean
    Indicates whether to return the timestamps and raw data values of this metric.
    expression str
    The math expression to perform on the returned data, if this object is performing a math expression.
    id str
    A short name that identifies the object's results in the response.
    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.
    return_data bool
    Indicates whether to return the timestamps and raw data values of this metric.
    expression String
    The math expression to perform on the returned data, if this object is performing a math expression.
    id String
    A short name that identifies the object's results in the response.
    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.
    returnData Boolean
    Indicates whether to return the timestamps and raw data values of this metric.

    ScalingPolicyTargetTrackingMetricDimension, ScalingPolicyTargetTrackingMetricDimensionArgs

    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.

    ScalingPolicyTargetTrackingMetricStat, ScalingPolicyTargetTrackingMetricStatArgs

    Metric Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    Stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    Unit string
    The unit to use for the returned data points.
    Metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    Stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    Unit string
    The unit to use for the returned data points.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    stat String
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    unit String
    The unit to use for the returned data points.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    unit string
    The unit to use for the returned data points.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    stat str
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    unit str
    The unit to use for the returned data points.
    metric Property Map
    The CloudWatch metric to return, including the metric name, namespace, and dimensions.
    stat String
    The statistic to return. It can include any CloudWatch statistic or extended statistic.
    unit String
    The unit to use for the returned data points.

    ScalingPolicyTargetTrackingScalingPolicyConfiguration, ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs

    TargetValue double
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    CustomizedMetricSpecification Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    PredefinedMetricSpecification Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    ScaleInCooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    ScaleOutCooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
    TargetValue float64
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    CustomizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    PredefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    ScaleInCooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    ScaleOutCooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
    targetValue Double
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown Integer
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    scaleOutCooldown Integer
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
    targetValue number
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown number
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    scaleOutCooldown number
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
    target_value float
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customized_metric_specification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disable_scale_in bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefined_metric_specification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scale_in_cooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    scale_out_cooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
    targetValue Number
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification Property Map
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification Property Map
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown Number
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
    scaleOutCooldown Number
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

    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.105.0 published on Thursday, May 2, 2024 by Pulumi