Class: Aws::AutoScaling::Types::PredictiveScalingMetricSpecification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass PredictiveScalingMetricSpecification data as a hash:

{
  target_value: 1.0, # required
  predefined_metric_pair_specification: {
    predefined_metric_type: "ASGCPUUtilization", # required, accepts ASGCPUUtilization, ASGNetworkIn, ASGNetworkOut, ALBRequestCount
    resource_label: "XmlStringMaxLen1023",
  },
  predefined_scaling_metric_specification: {
    predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
    resource_label: "XmlStringMaxLen1023",
  },
  predefined_load_metric_specification: {
    predefined_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
    resource_label: "XmlStringMaxLen1023",
  },
  customized_scaling_metric_specification: {
    metric_data_queries: [ # required
      {
        id: "XmlStringMaxLen255", # required
        expression: "XmlStringMaxLen1023",
        metric_stat: {
          metric: { # required
            namespace: "MetricNamespace", # required
            metric_name: "MetricName", # required
            dimensions: [
              {
                name: "MetricDimensionName", # required
                value: "MetricDimensionValue", # required
              },
            ],
          },
          stat: "XmlStringMetricStat", # required
          unit: "MetricUnit",
        },
        label: "XmlStringMetricLabel",
        return_data: false,
      },
    ],
  },
  customized_load_metric_specification: {
    metric_data_queries: [ # required
      {
        id: "XmlStringMaxLen255", # required
        expression: "XmlStringMaxLen1023",
        metric_stat: {
          metric: { # required
            namespace: "MetricNamespace", # required
            metric_name: "MetricName", # required
            dimensions: [
              {
                name: "MetricDimensionName", # required
                value: "MetricDimensionValue", # required
              },
            ],
          },
          stat: "XmlStringMetricStat", # required
          unit: "MetricUnit",
        },
        label: "XmlStringMetricLabel",
        return_data: false,
      },
    ],
  },
  customized_capacity_metric_specification: {
    metric_data_queries: [ # required
      {
        id: "XmlStringMaxLen255", # required
        expression: "XmlStringMaxLen1023",
        metric_stat: {
          metric: { # required
            namespace: "MetricNamespace", # required
            metric_name: "MetricName", # required
            dimensions: [
              {
                name: "MetricDimensionName", # required
                value: "MetricDimensionValue", # required
              },
            ],
          },
          stat: "XmlStringMetricStat", # required
          unit: "MetricUnit",
        },
        label: "XmlStringMetricLabel",
        return_data: false,
      },
    ],
  },
}

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

Example

  • You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.

  • The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the RequestCount and RequestCountPerTarget metrics, respectively.

  • For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.

  • Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)

  • After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customized_capacity_metric_specificationTypes::PredictiveScalingCustomizedCapacityMetric

The customized capacity metric specification.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#customized_load_metric_specificationTypes::PredictiveScalingCustomizedLoadMetric

The customized load metric specification.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#customized_scaling_metric_specificationTypes::PredictiveScalingCustomizedScalingMetric

The customized scaling metric specification.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#predefined_load_metric_specificationTypes::PredictiveScalingPredefinedLoadMetric

The predefined load metric specification.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#predefined_metric_pair_specificationTypes::PredictiveScalingPredefinedMetricPair

The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#predefined_scaling_metric_specificationTypes::PredictiveScalingPredefinedScalingMetric

The predefined scaling metric specification.



6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end

#target_valueFloat

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.

Returns:

  • (Float)


6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6437

class PredictiveScalingMetricSpecification < Struct.new(
  :target_value,
  :predefined_metric_pair_specification,
  :predefined_scaling_metric_specification,
  :predefined_load_metric_specification,
  :customized_scaling_metric_specification,
  :customized_load_metric_specification,
  :customized_capacity_metric_specification)
  SENSITIVE = []
  include Aws::Structure
end