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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#adjustment_typeString

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#alarmsArray<Types::Alarm>

The CloudWatch alarms related to the policy.

Returns:



5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#cooldownInteger

The duration of the policy's cooldown period, in seconds.

Returns:

  • (Integer)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

Indicates whether the policy is enabled (true) or disabled (false).

Returns:

  • (Boolean)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  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)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#metric_aggregation_typeString

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

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#min_adjustment_magnitudeInteger

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

Returns:

  • (Integer)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#min_adjustment_stepInteger

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

  • (Integer)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#policy_arnString

The Amazon Resource Name (ARN) of the policy.

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#policy_nameString

The name of the scaling policy.

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#policy_typeString

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.

Returns:

  • (String)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  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)


5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  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:



5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end

#target_tracking_configurationTypes::TargetTrackingConfiguration

A target tracking scaling policy.



5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5117

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)
  SENSITIVE = []
  include Aws::Structure
end