You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Types::ScalingPolicy

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

Overview

Describes a scaling policy.

Instance Attribute Summary collapse

Instance Attribute Details

#adjustment_typeString

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#alarmsArray<Types::Alarm>

The CloudWatch alarms related to the policy.

Returns:



4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#cooldownInteger

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

Returns:

  • (Integer)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#estimated_instance_warmupInteger

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Returns:

  • (Integer)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#metric_aggregation_typeString

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#min_adjustment_magnitudeInteger

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Returns:

  • (Integer)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#min_adjustment_stepInteger

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

  • (Integer)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#policy_arnString

The Amazon Resource Name (ARN) of the policy.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#policy_nameString

The name of the scaling policy.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#policy_typeString

The policy type. The valid values are SimpleScaling and StepScaling.

Returns:

  • (String)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#scaling_adjustmentInteger

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.

Returns:

  • (Integer)


4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#step_adjustmentsArray<Types::StepAdjustment>

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

Returns:



4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end

#target_tracking_configurationTypes::TargetTrackingConfiguration

A target tracking scaling policy.



4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4133

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)
  include Aws::Structure
end