Class: Aws::ApplicationAutoScaling::Types::StepScalingPolicyConfiguration

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

Overview

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

For more information, see [Step scaling policies] in the *Application Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#adjustment_type ⇒ String

Specifies how the ‘ScalingAdjustment` value in a [StepAdjustment] is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.

‘AdjustmentType` is required if you are adding a new step scaling policy configuration.

[1]: docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html

Returns:

  • (String) 


3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3663

class StepScalingPolicyConfiguration < Struct.new(
  :adjustment_type,
  :step_adjustments,
  :min_adjustment_magnitude,
  :cooldown,
  :metric_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#cooldown ⇒ Integer

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period] in the *Application Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown

Returns:

  • (Integer) 


3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3663

class StepScalingPolicyConfiguration < Struct.new(
  :adjustment_type,
  :step_adjustments,
  :min_adjustment_magnitude,
  :cooldown,
  :metric_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#metric_aggregation_type ⇒ 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`.

Returns:

  • (String) 


3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3663

class StepScalingPolicyConfiguration < Struct.new(
  :adjustment_type,
  :step_adjustments,
  :min_adjustment_magnitude,
  :cooldown,
  :metric_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#min_adjustment_magnitude ⇒ 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 Amazon ECS service by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Application Auto Scaling scales out the service by 2 tasks.

Returns:

  • (Integer) 


3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3663

class StepScalingPolicyConfiguration < Struct.new(
  :adjustment_type,
  :step_adjustments,
  :min_adjustment_magnitude,
  :cooldown,
  :metric_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end

#step_adjustments ⇒ Array<Types::StepAdjustment>

A set of adjustments that enable you to scale based on the size of the alarm breach.

At least one step adjustment is required if you are adding a new step scaling policy configuration.

Returns:



3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 3663

class StepScalingPolicyConfiguration < Struct.new(
  :adjustment_type,
  :step_adjustments,
  :min_adjustment_magnitude,
  :cooldown,
  :metric_aggregation_type)
  SENSITIVE = []
  include Aws::Structure
end