Class: Aws::AutoScaling::Types::ScalingPolicy
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScaling::Types::ScalingPolicy
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-autoscaling/types.rb
Overview
Describes a scaling policy.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#adjustment_type ⇒ String
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
-
#alarms ⇒ Array<Types::Alarm>
The CloudWatch alarms related to the policy.
-
#auto_scaling_group_name ⇒ String
The name of the Auto Scaling group.
-
#cooldown ⇒ Integer
The duration of the policy’s cooldown period, in seconds.
-
#enabled ⇒ Boolean
Indicates whether the policy is enabled (‘true`) or disabled (`false`).
-
#estimated_instance_warmup ⇒ Integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
-
#metric_aggregation_type ⇒ String
The aggregation type for the CloudWatch metrics.
-
#min_adjustment_magnitude ⇒ Integer
The minimum value to scale by when the adjustment type is ‘PercentChangeInCapacity`.
-
#min_adjustment_step ⇒ Integer
Available for backward compatibility.
-
#policy_arn ⇒ String
The Amazon Resource Name (ARN) of the policy.
-
#policy_name ⇒ String
The name of the scaling policy.
-
#policy_type ⇒ String
One of the following policy types:.
-
#predictive_scaling_configuration ⇒ Types::PredictiveScalingConfiguration
A predictive scaling policy.
-
#scaling_adjustment ⇒ Integer
The amount by which to scale, based on the specified adjustment type.
-
#step_adjustments ⇒ Array<Types::StepAdjustment>
A set of adjustments that enable you to scale based on the size of the alarm breach.
-
#target_tracking_configuration ⇒ Types::TargetTrackingConfiguration
A target tracking scaling policy.
Instance Attribute Details
#adjustment_type ⇒ String
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ‘ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#alarms ⇒ Array<Types::Alarm>
The CloudWatch alarms related to the policy.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#auto_scaling_group_name ⇒ String
The name of the Auto Scaling group.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#cooldown ⇒ Integer
The duration of the policy’s cooldown period, in seconds.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#enabled ⇒ Boolean
Indicates whether the policy is enabled (‘true`) or disabled (`false`).
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#estimated_instance_warmup ⇒ Integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#metric_aggregation_type ⇒ String
The aggregation type for the CloudWatch metrics. The valid values are ‘Minimum`, `Maximum`, and `Average`.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#min_adjustment_magnitude ⇒ Integer
The minimum value to scale by when the adjustment type is ‘PercentChangeInCapacity`.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#min_adjustment_step ⇒ Integer
Available for backward compatibility. Use ‘MinAdjustmentMagnitude` instead.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#policy_arn ⇒ String
The Amazon Resource Name (ARN) of the policy.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#policy_name ⇒ String
The name of the scaling policy.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#policy_type ⇒ String
One of the following policy types:
-
‘TargetTrackingScaling`
-
‘StepScaling`
-
‘SimpleScaling` (default)
-
‘PredictiveScaling`
For more information, see [Target tracking scaling policies] and
- Step and simple scaling policies][2
-
in the *Amazon EC2 Auto
Scaling User Guide*.
[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html [2]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#predictive_scaling_configuration ⇒ Types::PredictiveScalingConfiguration
A predictive scaling policy.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#scaling_adjustment ⇒ 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.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) 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.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |
#target_tracking_configuration ⇒ Types::TargetTrackingConfiguration
A target tracking scaling policy.
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 |
# File 'lib/aws-sdk-autoscaling/types.rb', line 6554 class ScalingPolicy < Struct.new( :auto_scaling_group_name, :policy_name, :policy_arn, :policy_type, :adjustment_type, :min_adjustment_step, :min_adjustment_magnitude, :scaling_adjustment, :cooldown, :step_adjustments, :metric_aggregation_type, :estimated_instance_warmup, :alarms, :target_tracking_configuration, :enabled, :predictive_scaling_configuration) SENSITIVE = [] include Aws::Structure end |