Class: Aws::ApplicationAutoScaling::Types::TargetTrackingScalingPolicyConfiguration

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

Overview

Note:

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

{
  target_value: 1.0, # required
  predefined_metric_specification: {
    predefined_metric_type: "DynamoDBReadCapacityUtilization", # required, accepts DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, SageMakerVariantInvocationsPerInstance, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, AppStreamAverageCapacityUtilization, ComprehendInferenceUtilization, LambdaProvisionedConcurrencyUtilization, CassandraReadCapacityUtilization, CassandraWriteCapacityUtilization, KafkaBrokerStorageUtilization, ElastiCachePrimaryEngineCPUUtilization, ElastiCacheReplicaEngineCPUUtilization, ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage, NeptuneReaderAverageCPUUtilization
    resource_label: "ResourceLabel",
  },
  customized_metric_specification: {
    metric_name: "MetricName", # required
    namespace: "MetricNamespace", # required
    dimensions: [
      {
        name: "MetricDimensionName", # required
        value: "MetricDimensionValue", # required
      },
    ],
    statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
    unit: "MetricUnit",
  },
  scale_out_cooldown: 1,
  scale_in_cooldown: 1,
  disable_scale_in: false,
}

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customized_metric_specificationTypes::CustomizedMetricSpecification

A customized metric. You can specify either a predefined metric or a customized metric.



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#disable_scale_inBoolean

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.

Returns:

  • (Boolean)


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#predefined_metric_specificationTypes::PredefinedMetricSpecification

A predefined metric. You can specify either a predefined metric or a customized metric.



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#scale_in_cooldownInteger

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.

With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

  • AppStream 2.0 fleets

  • Aurora DB clusters

  • ECS services

  • EMR clusters

  • Neptune clusters

  • SageMaker endpoint variants

  • Spot Fleets

  • Custom resources

For all other scalable targets, the default value is 0:

  • Amazon Comprehend document classification and entity recognizer endpoints

  • DynamoDB tables and global secondary indexes

  • Amazon Keyspaces tables

  • Lambda provisioned concurrency

  • Amazon MSK broker storage

Returns:

  • (Integer)


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#scale_out_cooldownInteger

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

  • AppStream 2.0 fleets

  • Aurora DB clusters

  • ECS services

  • EMR clusters

  • Neptune clusters

  • SageMaker endpoint variants

  • Spot Fleets

  • Custom resources

For all other scalable targets, the default value is 0:

  • Amazon Comprehend document classification and entity recognizer endpoints

  • DynamoDB tables and global secondary indexes

  • Amazon Keyspaces tables

  • Lambda provisioned concurrency

  • Amazon MSK broker storage

Returns:

  • (Integer)


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#target_valueFloat

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 -2360 to 2360. 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.

Returns:

  • (Float)


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 3726

class TargetTrackingScalingPolicyConfiguration < Struct.new(
  :target_value,
  :predefined_metric_specification,
  :customized_metric_specification,
  :scale_out_cooldown,
  :scale_in_cooldown,
  :disable_scale_in)
  SENSITIVE = []
  include Aws::Structure
end