AWSAutoScalingPutScalingPolicyType

@interface AWSAutoScalingPutScalingPolicyType

  • Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

    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.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable adjustmentType;

    Swift

    var adjustmentType: String? { get set }

  • The name of the Auto Scaling group.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    NSString *_Nullable autoScalingGroupName;

    Swift

    var autoScalingGroupName: String? { get set }

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

    Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) 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 (readwrite, strong, nonatomic) 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. The default is to use the value specified for the default cooldown period for the group.

    Valid only if the policy type is StepScaling or TargetTrackingScaling.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    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 (readwrite, strong, nonatomic)
    NSString *_Nullable metricAggregationType;

    Swift

    var metricAggregationType: String? { get set }

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

    This property replaces the MinAdjustmentStep property. 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 SimpleScaling or StepScaling.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
    NSNumber *_Nullable minAdjustmentMagnitude;

    Swift

    var minAdjustmentMagnitude: NSNumber? { get set }

  • Available for backward compatibility. Use MinAdjustmentMagnitude instead.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSNumber *_Nullable minAdjustmentStep;

    Swift

    var minAdjustmentStep: NSNumber? { get set }

  • The name of the policy.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable policyName;

    Swift

    var policyName: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var policyType: String? { get set }

  • The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

    Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) 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.

    Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

    Declaration

    Objective-C

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

    Swift

    var stepAdjustments: [AWSAutoScalingStepAdjustment]? { get set }

  • A target tracking scaling policy. Includes support for predefined or customized metrics.

    For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

    Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

    Declaration

    Objective-C

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

    Swift

    var targetTrackingConfiguration: AWSAutoScalingTargetTrackingConfiguration? { get set }