putScalingPolicy method

Future<PolicyARNType> putScalingPolicy({ required String autoScalingGroupName, required String policyName, String? adjustmentType, int? cooldown, bool? enabled, int? estimatedInstanceWarmup, String? metricAggregationType, int? minAdjustmentMagnitude, int? minAdjustmentStep, String? policyType, int? scalingAdjustment, List<StepAdjustment>? stepAdjustments, TargetTrackingConfiguration? targetTrackingConfiguration, })

Creates or updates a scaling policy for an Auto Scaling group.

For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

May throw LimitExceededFault. May throw ResourceContentionFault. May throw ServiceLinkedRoleFailure.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

Parameter policyName : The name of the policy.

Parameter adjustmentType : 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.

Parameter cooldown : 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.

Parameter enabled : 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.

Parameter estimatedInstanceWarmup : 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 or StepScaling.

Parameter metricAggregationType : 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.

Parameter minAdjustmentMagnitude : 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.

Parameter minAdjustmentStep : Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Parameter policyType : One of the following policy types:

• TargetTrackingScaling
• StepScaling
• SimpleScaling (default)

Parameter 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. For exact capacity, you must specify a positive value.

Required if the policy type is SimpleScaling. (Not used with any other policy type.)

Parameter stepAdjustments : 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.)

Parameter targetTrackingConfiguration : 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 the ResourceLabel parameter with the PredefinedMetricSpecification.

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

Required if the policy type is TargetTrackingScaling.

Implementation

Future<PolicyARNType> putScalingPolicy({
  required String autoScalingGroupName,
  required String policyName,
  String? adjustmentType,
  int? cooldown,
  bool? enabled,
  int? estimatedInstanceWarmup,
  String? metricAggregationType,
  int? minAdjustmentMagnitude,
  int? minAdjustmentStep,
  String? policyType,
  int? scalingAdjustment,
  List<StepAdjustment>? stepAdjustments,
  TargetTrackingConfiguration? targetTrackingConfiguration,
}) async {
  ArgumentError.checkNotNull(autoScalingGroupName, 'autoScalingGroupName');
  _s.validateStringLength(
    'autoScalingGroupName',
    autoScalingGroupName,
    1,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(policyName, 'policyName');
  _s.validateStringLength(
    'policyName',
    policyName,
    1,
    255,
    isRequired: true,
  );
  _s.validateStringLength(
    'adjustmentType',
    adjustmentType,
    1,
    255,
  );
  _s.validateStringLength(
    'metricAggregationType',
    metricAggregationType,
    1,
    32,
  );
  _s.validateStringLength(
    'policyType',
    policyType,
    1,
    64,
  );
  final $request = <String, dynamic>{};
  $request['AutoScalingGroupName'] = autoScalingGroupName;
  $request['PolicyName'] = policyName;
  adjustmentType?.also((arg) => $request['AdjustmentType'] = arg);
  cooldown?.also((arg) => $request['Cooldown'] = arg);
  enabled?.also((arg) => $request['Enabled'] = arg);
  estimatedInstanceWarmup
      ?.also((arg) => $request['EstimatedInstanceWarmup'] = arg);
  metricAggregationType
      ?.also((arg) => $request['MetricAggregationType'] = arg);
  minAdjustmentMagnitude
      ?.also((arg) => $request['MinAdjustmentMagnitude'] = arg);
  minAdjustmentStep?.also((arg) => $request['MinAdjustmentStep'] = arg);
  policyType?.also((arg) => $request['PolicyType'] = arg);
  scalingAdjustment?.also((arg) => $request['ScalingAdjustment'] = arg);
  stepAdjustments?.also((arg) => $request['StepAdjustments'] = arg);
  targetTrackingConfiguration
      ?.also((arg) => $request['TargetTrackingConfiguration'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'PutScalingPolicy',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['PutScalingPolicyType'],
    shapes: shapes,
    resultWrapper: 'PutScalingPolicyResult',
  );
  return PolicyARNType.fromXml($result);
}