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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #adjustment_type ⇒ String

  The adjustment type, which specifies how ‘ScalingAdjustment` is interpreted.

• #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 amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

• #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 number of instances to scale.

• #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

  The policy type.

• #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 policy.

Instance Attribute Details

#adjustment_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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

#alarms ⇒ Array<Types::Alarm>

The CloudWatch alarms related to the policy.

Returns:

• (Array<Types::Alarm>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_name ⇒ String

The name of the Auto Scaling group.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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

#cooldown ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_warmup ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_type ⇒ String

The aggregation type for the CloudWatch metrics. Valid values are ‘Minimum`, `Maximum`, and `Average`.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_magnitude ⇒ Integer

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)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_step ⇒ Integer

Available for backward compatibility. Use ‘MinAdjustmentMagnitude` instead.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_arn ⇒ String

The Amazon Resource Name (ARN) of the policy.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_name ⇒ String

The name of the scaling policy.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_type ⇒ String

The policy type. Valid values are ‘SimpleScaling` and `StepScaling`.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_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.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_adjustments ⇒ Array<Types::StepAdjustment>

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

Returns:

• (Array<Types::StepAdjustment>)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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_configuration ⇒ Types::TargetTrackingConfiguration

A target tracking policy.

Returns:

• (Types::TargetTrackingConfiguration)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3975

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