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

    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 }

  • 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

    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 }

  • 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.

    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, and Average. If the aggregation type is null, the value is treated as Average.

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

    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)

    • PredictiveScaling

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable policyType;

    Swift

    var policyType: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingPredictiveScalingConfiguration *_Nullable predictiveScalingConfiguration;

    Swift

    var predictiveScalingConfiguration: AWSAutoScalingPredictiveScalingConfiguration? { 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. 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingTargetTrackingConfiguration *_Nullable targetTrackingConfiguration;

    Swift

    var targetTrackingConfiguration: AWSAutoScalingTargetTrackingConfiguration? { get set }