You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::AutoScaling::Types::ScalingPolicy
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScaling::Types::ScalingPolicy
- Defined in:
- (unknown)
Overview
Describes a scaling policy.
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:.
-
#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
.
#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. The valid values are
Minimum
, Maximum
, and Average
.
#min_adjustment_magnitude ⇒ Integer
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity
.
#min_adjustment_step ⇒ Integer
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
#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:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
#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.
#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.