Class: Aws::AutoScaling::Types::PutScalingPolicyType

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::PutScalingPolicyType

Defined in:

gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #adjustment_type ⇒ String

  Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).

• #auto_scaling_group_name ⇒ String

  The name of the Auto Scaling group.

• #cooldown ⇒ Integer

  A cooldown period, in seconds, that applies to a specific simple scaling policy.

• #enabled ⇒ Boolean

  Indicates whether the scaling policy is enabled or disabled.

• #estimated_instance_warmup ⇒ Integer

  Not needed if the default instance warmup is defined for the group..

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

  The name of the 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.

Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Returns:

• (String)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

• (String)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cooldown ⇒ Integer

A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Default: None

Returns:

• (Integer)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Returns:

• (Boolean)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_instance_warmup ⇒ Integer

Not needed if the default instance warmup is defined for the group.

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

Valid only if the policy type is TargetTrackingScaling or StepScaling.

The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

Returns:

• (Integer)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :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. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Returns:

• (String)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :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. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

Returns:

• (Integer)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#min_adjustment_step ⇒ Integer

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

• (Integer)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ String

The name of the policy.

Returns:

• (String)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :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

Returns:

• (String)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#predictive_scaling_configuration ⇒ Types::PredictiveScalingConfiguration

A predictive scaling policy. Provides support for predefined and custom metrics.

Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is PredictiveScaling.

Returns:

• (Types::PredictiveScalingConfiguration)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :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. For exact capacity, you must specify a non-negative value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Returns:

• (Integer)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :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.

Required if the policy type is StepScaling. (Not used with any other policy type.)

Returns:

• (Array<Types::StepAdjustment>)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#target_tracking_configuration ⇒ Types::TargetTrackingConfiguration

A target tracking scaling policy. Provides support for predefined or custom metrics.

The following predefined metrics are available:

• ASGAverageCPUUtilization

• ASGAverageNetworkIn

• ASGAverageNetworkOut

• ALBRequestCountPerTarget

If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Required if the policy type is TargetTrackingScaling.

Returns:

• (Types::TargetTrackingConfiguration)

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

class PutScalingPolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :policy_type,
  :adjustment_type,
  :min_adjustment_step,
  :min_adjustment_magnitude,
  :scaling_adjustment,
  :cooldown,
  :metric_aggregation_type,
  :step_adjustments,
  :estimated_instance_warmup,
  :target_tracking_configuration,
  :enabled,
  :predictive_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end