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

Inherits:

Struct

Object
Struct
Aws::AutoScaling::Types::ScalingPolicy

show all

Includes:: Structure

Defined in:: lib/aws-sdk-autoscaling/types.rb

Overview

Describes a scaling policy.

Constant Summary collapse

SENSITIVE =

[]

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:.
#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`.

Returns:

(String)

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

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

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

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

#cooldown ⇒ `Integer`

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

Returns:

(Integer)

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

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

#enabled ⇒ `Boolean`

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

Returns:

(Boolean)

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

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

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,
  :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`.

Returns:

(String)

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

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

#min_adjustment_magnitude ⇒ `Integer`

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

Returns:

(Integer)

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

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

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

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

#policy_name ⇒ `String`

The name of the scaling policy.

Returns:

(String)

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

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

#policy_type ⇒ `String`

One of the following policy types:

‘TargetTrackingScaling`
‘StepScaling`
‘SimpleScaling` (default)
‘PredictiveScaling`

For more information, see [Target tracking scaling policies] and

Step and simple scaling policies][2: in the *Amazon EC2 Auto

Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html [2]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html

Returns:

(String)

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

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

#predictive_scaling_configuration ⇒ `Types::PredictiveScalingConfiguration`

A predictive scaling policy.

Returns:

(Types::PredictiveScalingConfiguration)

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

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,
  :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.

Returns:

(Integer)

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

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,
  :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.

Returns:

(Array<Types::StepAdjustment>)

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

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

#target_tracking_configuration ⇒ `Types::TargetTrackingConfiguration`

A target tracking scaling policy.

Returns:

(Types::TargetTrackingConfiguration)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#adjustment_type ⇒ String

#alarms ⇒ Array<Types::Alarm>

#auto_scaling_group_name ⇒ String

#cooldown ⇒ Integer

#enabled ⇒ Boolean

#estimated_instance_warmup ⇒ Integer

#metric_aggregation_type ⇒ String

#min_adjustment_magnitude ⇒ Integer

#min_adjustment_step ⇒ Integer

#policy_arn ⇒ String

#policy_name ⇒ String

#policy_type ⇒ String

#predictive_scaling_configuration ⇒ Types::PredictiveScalingConfiguration

#scaling_adjustment ⇒ Integer

#step_adjustments ⇒ Array<Types::StepAdjustment>

#target_tracking_configuration ⇒ Types::TargetTrackingConfiguration

#adjustment_type ⇒ `String`

#alarms ⇒ `Array<Types::Alarm>`

#auto_scaling_group_name ⇒ `String`

#cooldown ⇒ `Integer`

#enabled ⇒ `Boolean`

#estimated_instance_warmup ⇒ `Integer`

#metric_aggregation_type ⇒ `String`

#min_adjustment_magnitude ⇒ `Integer`

#min_adjustment_step ⇒ `Integer`

#policy_arn ⇒ `String`

#policy_name ⇒ `String`

#policy_type ⇒ `String`

#predictive_scaling_configuration ⇒ `Types::PredictiveScalingConfiguration`

#scaling_adjustment ⇒ `Integer`

#step_adjustments ⇒ `Array<Types::StepAdjustment>`

#target_tracking_configuration ⇒ `Types::TargetTrackingConfiguration`