AWSAutoScalingPutScalingPolicyType
Objective-C
@interface AWSAutoScalingPutScalingPolicyType
Swift
class AWSAutoScalingPutScalingPolicyType
-
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are
ChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.Required if the policy type is
StepScaling
orSimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable adjustmentType;
Swift
var adjustmentType: String? { get set }
-
The name of the Auto Scaling group.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable autoScalingGroupName;
Swift
var autoScalingGroupName: String? { get set }
-
The duration of the policy’s cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
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.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable cooldown;
Swift
var cooldown: NSNumber? { get set }
-
Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable enabled;
Swift
var enabled: NSNumber? { get set }
-
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.
Valid only if the policy type is
TargetTrackingScaling
orStepScaling
.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable estimatedInstanceWarmup;
Swift
var estimatedInstanceWarmup: NSNumber? { get set }
-
The aggregation type for the CloudWatch metrics. The valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.Valid only if the policy type is
StepScaling
.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable metricAggregationType;
Swift
var metricAggregationType: String? { get set }
-
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 aMinAdjustmentMagnitude
of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.Valid only if the policy type is
StepScaling
orSimpleScaling
. 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.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable minAdjustmentMagnitude;
Swift
var minAdjustmentMagnitude: NSNumber? { get set }
-
Available for backward compatibility. Use
MinAdjustmentMagnitude
instead.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable minAdjustmentStep;
Swift
var minAdjustmentStep: NSNumber? { get set }
-
The name of the policy.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable policyName;
Swift
var policyName: String? { get set }
-
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable policyType;
Swift
var policyType: String? { get set }
-
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 positive value.
Required if the policy type is
SimpleScaling
. (Not used with any other policy type.)Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable scalingAdjustment;
Swift
var scalingAdjustment: NSNumber? { get set }
-
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.)Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSAutoScalingStepAdjustment *> *_Nullable stepAdjustments;
Swift
var stepAdjustments: [AWSAutoScalingStepAdjustment]? { get set }
-
A target tracking scaling policy. Includes support for predefined or customized metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
If you specify
ALBRequestCountPerTarget
for the metric, you must specify theResourceLabel
parameter with thePredefinedMetricSpecification
.For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
TargetTrackingScaling
.Declaration
Objective-C
@property (nonatomic, strong) AWSAutoScalingTargetTrackingConfiguration *_Nullable targetTrackingConfiguration;
Swift
var targetTrackingConfiguration: AWSAutoScalingTargetTrackingConfiguration? { get set }