AWSAutoScalingPutScalingPolicyType Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSAutoScalingModel.h
AWSAutoScalingModel.m

Overview

Contains the parameters for PutScalingPolicy.

Required parameters: [AutoScalingGroupName, PolicyName, AdjustmentType]

  adjustmentType

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

@property (nonatomic, strong) NSString *adjustmentType

Declared In

AWSAutoScalingModel.h

  autoScalingGroupName

The name or ARN of the group.

@property (nonatomic, strong) NSString *autoScalingGroupName

Declared In

AWSAutoScalingModel.h

  cooldown

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is not supported unless the policy type is SimpleScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

@property (nonatomic, strong) NSNumber *cooldown

Declared In

AWSAutoScalingModel.h

  estimatedInstanceWarmup

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is not supported if the policy type is SimpleScaling.

@property (nonatomic, strong) NSNumber *estimatedInstanceWarmup

Declared In

AWSAutoScalingModel.h

  metricAggregationType

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is not supported if the policy type is SimpleScaling.

@property (nonatomic, strong) NSString *metricAggregationType

Declared In

AWSAutoScalingModel.h

  minAdjustmentMagnitude

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.

@property (nonatomic, strong) NSNumber *minAdjustmentMagnitude

Declared In

AWSAutoScalingModel.h

  minAdjustmentStep

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

@property (nonatomic, strong) NSNumber *minAdjustmentStep

Declared In

AWSAutoScalingModel.h

  policyName

The name of the policy.

@property (nonatomic, strong) NSString *policyName

Declared In

AWSAutoScalingModel.h

  policyType

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

@property (nonatomic, strong) NSString *policyType

Declared In

AWSAutoScalingModel.h

  scalingAdjustment

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.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

@property (nonatomic, strong) NSNumber *scalingAdjustment

Declared In

AWSAutoScalingModel.h

  stepAdjustments

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

This parameter is required if the policy type is StepScaling and not supported otherwise.

@property (nonatomic, strong) NSArray<AWSAutoScalingStepAdjustment*> *stepAdjustments

Declared In

AWSAutoScalingModel.h