AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a scaling policy.

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)

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

#alarmsArray<Types::Alarm>

The CloudWatch alarms related to the policy.

Returns:

  • (Array<Types::Alarm>)

    The CloudWatch alarms related to the policy.

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)

    The name of the Auto Scaling group.

#cooldownInteger

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

Returns:

  • (Integer)

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

#enabledBoolean

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

Returns:

  • (Boolean)

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

#estimated_instance_warmupInteger

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

Returns:

  • (Integer)

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

#metric_aggregation_typeString

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

Returns:

  • (String)

    The aggregation type for the CloudWatch metrics.

#min_adjustment_magnitudeInteger

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

Returns:

  • (Integer)

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

#min_adjustment_stepInteger

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

  • (Integer)

    Available for backward compatibility.

#policy_arnString

The Amazon Resource Name (ARN) of the policy.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the policy.

#policy_nameString

The name of the scaling policy.

Returns:

  • (String)

    The name of the scaling policy.

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

    One of the following policy types:.

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

    The amount by which to scale, based on the specified adjustment type.

#step_adjustmentsArray<Types::StepAdjustment>

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

Returns:

  • (Array<Types::StepAdjustment>)

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

#target_tracking_configurationTypes::TargetTrackingConfiguration

A target tracking scaling policy.

Returns: