PUTSCALINGPOLICY()`¶

About PutScalingPolicy¶

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

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

For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

Method Signature¶

METHODS /AWS1/IF_ASC~PUTSCALINGPOLICY
  IMPORTING
    !IV_AUTOSCALINGGROUPNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_POLICYNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_POLICYTYPE TYPE /AWS1/ASCXMLSTRINGMAXLEN64 OPTIONAL
    !IV_ADJUSTMENTTYPE TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_MINADJUSTMENTSTEP TYPE /AWS1/ASCMINADJUSTMENTSTEP OPTIONAL
    !IV_MINADJUSTMENTMAGNITUDE TYPE /AWS1/ASCMINADJUSTMENTMAGNIT00 OPTIONAL
    !IV_SCALINGADJUSTMENT TYPE /AWS1/ASCPOLICYINCREMENT OPTIONAL
    !IV_COOLDOWN TYPE /AWS1/ASCCOOLDOWN OPTIONAL
    !IV_METRICAGGREGATIONTYPE TYPE /AWS1/ASCXMLSTRINGMAXLEN32 OPTIONAL
    !IT_STEPADJUSTMENTS TYPE /AWS1/CL_ASCSTEPADJUSTMENT=>TT_STEPADJUSTMENTS OPTIONAL
    !IV_ESTIMATEDINSTANCEWARMUP TYPE /AWS1/ASCESTIMATEDINSTWARMUP OPTIONAL
    !IO_TARGETTRACKINGCONF TYPE REF TO /AWS1/CL_ASCTARGETTRACKINGCONF OPTIONAL
    !IV_ENABLED TYPE /AWS1/ASCSCALINGPOLICYENABLED OPTIONAL
    !IO_PREDICTIVESCALINGCONF TYPE REF TO /AWS1/CL_ASCPREDICTIVESCACONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ascpolicyarntype
  RAISING
    /AWS1/CX_ASCLIMITEXCEEDEDFAULT
    /AWS1/CX_ASCRESRCCONTIONFAULT
    /AWS1/CX_ASCSVCLNKROLEFAILURE
    /AWS1/CX_ASCCLIENTEXC
    /AWS1/CX_ASCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_autoscalinggroupname` `TYPE /AWS1/ASCXMLSTRINGMAXLEN255` `/AWS1/ASCXMLSTRINGMAXLEN255`¶

The name of the Auto Scaling group.

`iv_policyname` `TYPE /AWS1/ASCXMLSTRINGMAXLEN255` `/AWS1/ASCXMLSTRINGMAXLEN255`¶

The name of the policy.

Optional arguments:¶

`iv_policytype` `TYPE /AWS1/ASCXMLSTRINGMAXLEN64` `/AWS1/ASCXMLSTRINGMAXLEN64`¶

One of the following policy types:

TargetTrackingScaling

StepScaling

SimpleScaling (default)

PredictiveScaling

`iv_adjustmenttype` `TYPE /AWS1/ASCXMLSTRINGMAXLEN255` `/AWS1/ASCXMLSTRINGMAXLEN255`¶

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.

`iv_minadjustmentstep` `TYPE /AWS1/ASCMINADJUSTMENTSTEP` `/AWS1/ASCMINADJUSTMENTSTEP`¶

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

`iv_minadjustmentmagnitude` `TYPE /AWS1/ASCMINADJUSTMENTMAGNIT00` `/AWS1/ASCMINADJUSTMENTMAGNIT00`¶

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.

`iv_scalingadjustment` `TYPE /AWS1/ASCPOLICYINCREMENT` `/AWS1/ASCPOLICYINCREMENT`¶

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 non-negative value.

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

`iv_cooldown` `TYPE /AWS1/ASCCOOLDOWN` `/AWS1/ASCCOOLDOWN`¶

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

`iv_metricaggregationtype` `TYPE /AWS1/ASCXMLSTRINGMAXLEN32` `/AWS1/ASCXMLSTRINGMAXLEN32`¶

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.

`it_stepadjustments` `TYPE /AWS1/CL_ASCSTEPADJUSTMENT=>TT_STEPADJUSTMENTS` `TT_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.)

`iv_estimatedinstancewarmup` `TYPE /AWS1/ASCESTIMATEDINSTWARMUP` `/AWS1/ASCESTIMATEDINSTWARMUP`¶

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.

`io_targettrackingconf` `TYPE REF TO /AWS1/CL_ASCTARGETTRACKINGCONF` `/AWS1/CL_ASCTARGETTRACKINGCONF`¶

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.

`iv_enabled` `TYPE /AWS1/ASCSCALINGPOLICYENABLED` `/AWS1/ASCSCALINGPOLICYENABLED`¶

Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

`io_predictivescalingconf` `TYPE REF TO /AWS1/CL_ASCPREDICTIVESCACONF` `/AWS1/CL_ASCPREDICTIVESCACONF`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ascpolicyarntype` `/AWS1/CL_ASCPOLICYARNTYPE`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->putscalingpolicy(
  io_predictivescalingconf = new /aws1/cl_ascpredictivescaconf(
    it_metricspecifications = VALUE /aws1/cl_ascpredictivescamet00=>tt_predictivescalingmetpecs(
      (
        new /aws1/cl_ascpredictivescamet00(
          io_customizedcapmetricspec = new /aws1/cl_ascpredictivescacus02(
            it_metricdataqueries = VALUE /aws1/cl_ascmetricdataquery=>tt_metricdataqueries(
              (
                new /aws1/cl_ascmetricdataquery(
                  io_metricstat = new /aws1/cl_ascmetricstat(
                    io_metric = new /aws1/cl_ascmetric(
                      it_dimensions = VALUE /aws1/cl_ascmetricdimension=>tt_metricdimensions(
                        (
                          new /aws1/cl_ascmetricdimension(
                            iv_name = |string|
                            iv_value = |string|
                          )
                        )
                      )
                      iv_metricname = |string|
                      iv_namespace = |string|
                    )
                    iv_stat = |string|
                    iv_unit = |string|
                  )
                  iv_expression = |string|
                  iv_id = |string|
                  iv_label = |string|
                  iv_returndata = ABAP_TRUE
                )
              )
            )
          )
          io_customizedloadmetricspec = new /aws1/cl_ascpredictivescacus01(
            it_metricdataqueries = VALUE /aws1/cl_ascmetricdataquery=>tt_metricdataqueries(
              (
                new /aws1/cl_ascmetricdataquery(
                  io_metricstat = new /aws1/cl_ascmetricstat(
                    io_metric = new /aws1/cl_ascmetric(
                      it_dimensions = VALUE /aws1/cl_ascmetricdimension=>tt_metricdimensions(
                        (
                          new /aws1/cl_ascmetricdimension(
                            iv_name = |string|
                            iv_value = |string|
                          )
                        )
                      )
                      iv_metricname = |string|
                      iv_namespace = |string|
                    )
                    iv_stat = |string|
                    iv_unit = |string|
                  )
                  iv_expression = |string|
                  iv_id = |string|
                  iv_label = |string|
                  iv_returndata = ABAP_TRUE
                )
              )
            )
          )
          io_customizedscalingmetpec = new /aws1/cl_ascpredictivescacus00(
            it_metricdataqueries = VALUE /aws1/cl_ascmetricdataquery=>tt_metricdataqueries(
              (
                new /aws1/cl_ascmetricdataquery(
                  io_metricstat = new /aws1/cl_ascmetricstat(
                    io_metric = new /aws1/cl_ascmetric(
                      it_dimensions = VALUE /aws1/cl_ascmetricdimension=>tt_metricdimensions(
                        (
                          new /aws1/cl_ascmetricdimension(
                            iv_name = |string|
                            iv_value = |string|
                          )
                        )
                      )
                      iv_metricname = |string|
                      iv_namespace = |string|
                    )
                    iv_stat = |string|
                    iv_unit = |string|
                  )
                  iv_expression = |string|
                  iv_id = |string|
                  iv_label = |string|
                  iv_returndata = ABAP_TRUE
                )
              )
            )
          )
          io_predefinedloadmetricspec = new /aws1/cl_ascpredictivescapre02(
            iv_predefinedmetrictype = |string|
            iv_resourcelabel = |string|
          )
          io_predefinedmetricpairspec = new /aws1/cl_ascpredictivescapre00(
            iv_predefinedmetrictype = |string|
            iv_resourcelabel = |string|
          )
          io_predefinedscalingmetpec = new /aws1/cl_ascpredictivescapre01(
            iv_predefinedmetrictype = |string|
            iv_resourcelabel = |string|
          )
          iv_targetvalue = '0.1'
        )
      )
    )
    iv_maxcapacitybreachbehavior = |string|
    iv_maxcapacitybuffer = 123
    iv_mode = |string|
    iv_schedulingbuffertime = 123
  )
  io_targettrackingconf = new /aws1/cl_asctargettrackingconf(
    io_customizedmetricspec = new /aws1/cl_asccustomizedmetpec(
      it_dimensions = VALUE /aws1/cl_ascmetricdimension=>tt_metricdimensions(
        (
          new /aws1/cl_ascmetricdimension(
            iv_name = |string|
            iv_value = |string|
          )
        )
      )
      it_metrics = VALUE /aws1/cl_asctgttrkmetricdata00=>tt_targettrkmetricdataqueries(
        (
          new /aws1/cl_asctgttrkmetricdata00(
            io_metricstat = new /aws1/cl_asctargettrkmettat(
              io_metric = new /aws1/cl_ascmetric(
                it_dimensions = VALUE /aws1/cl_ascmetricdimension=>tt_metricdimensions(
                  (
                    new /aws1/cl_ascmetricdimension(
                      iv_name = |string|
                      iv_value = |string|
                    )
                  )
                )
                iv_metricname = |string|
                iv_namespace = |string|
              )
              iv_period = 123
              iv_stat = |string|
              iv_unit = |string|
            )
            iv_expression = |string|
            iv_id = |string|
            iv_label = |string|
            iv_period = 123
            iv_returndata = ABAP_TRUE
          )
        )
      )
      iv_metricname = |string|
      iv_namespace = |string|
      iv_period = 123
      iv_statistic = |string|
      iv_unit = |string|
    )
    io_predefinedmetricspec = new /aws1/cl_ascpredefinedmetpec(
      iv_predefinedmetrictype = |string|
      iv_resourcelabel = |string|
    )
    iv_disablescalein = ABAP_TRUE
    iv_targetvalue = '0.1'
  )
  it_stepadjustments = VALUE /aws1/cl_ascstepadjustment=>tt_stepadjustments(
    (
      new /aws1/cl_ascstepadjustment(
        iv_metricintervallowerbound = '0.1'
        iv_metricintervalupperbound = '0.1'
        iv_scalingadjustment = 123
      )
    )
  )
  iv_adjustmenttype = |string|
  iv_autoscalinggroupname = |string|
  iv_cooldown = 123
  iv_enabled = ABAP_TRUE
  iv_estimatedinstancewarmup = 123
  iv_metricaggregationtype = |string|
  iv_minadjustmentmagnitude = 123
  iv_minadjustmentstep = 123
  iv_policyname = |string|
  iv_policytype = |string|
  iv_scalingadjustment = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcename = lo_result->get_policyarn( ).
  LOOP AT lo_result->get_alarms( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_xmlstringmaxlen255 = lo_row_1->get_alarmname( ).
      lv_resourcename = lo_row_1->get_alarmarn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To add a scaling policy to an Auto Scaling group¶

This example adds the specified policy to the specified Auto Scaling group.

DATA(lo_result) = lo_client->putscalingpolicy(
  io_targettrackingconf = new /aws1/cl_asctargettrackingconf(
    io_predefinedmetricspec = new /aws1/cl_ascpredefinedmetpec(
      iv_predefinedmetrictype = |ALBRequestCountPerTarget|
      iv_resourcelabel = |app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff|
    )
    iv_targetvalue = '1000.0'
  )
  iv_autoscalinggroupname = |my-auto-scaling-group|
  iv_policyname = |alb1000-target-tracking-scaling-policy|
  iv_policytype = |TargetTrackingScaling|
).

/AWS1/IF_ASC=>PUTSCALINGPOLICY()¶

About PutScalingPolicy¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_autoscalinggroupname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255¶

iv_policyname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255¶

Optional arguments:¶

iv_policytype TYPE /AWS1/ASCXMLSTRINGMAXLEN64 /AWS1/ASCXMLSTRINGMAXLEN64¶

iv_adjustmenttype TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255¶

iv_minadjustmentstep TYPE /AWS1/ASCMINADJUSTMENTSTEP /AWS1/ASCMINADJUSTMENTSTEP¶

iv_minadjustmentmagnitude TYPE /AWS1/ASCMINADJUSTMENTMAGNIT00 /AWS1/ASCMINADJUSTMENTMAGNIT00¶

iv_scalingadjustment TYPE /AWS1/ASCPOLICYINCREMENT /AWS1/ASCPOLICYINCREMENT¶

iv_cooldown TYPE /AWS1/ASCCOOLDOWN /AWS1/ASCCOOLDOWN¶

iv_metricaggregationtype TYPE /AWS1/ASCXMLSTRINGMAXLEN32 /AWS1/ASCXMLSTRINGMAXLEN32¶

it_stepadjustments TYPE /AWS1/CL_ASCSTEPADJUSTMENT=>TT_STEPADJUSTMENTS TT_STEPADJUSTMENTS¶

iv_estimatedinstancewarmup TYPE /AWS1/ASCESTIMATEDINSTWARMUP /AWS1/ASCESTIMATEDINSTWARMUP¶

io_targettrackingconf TYPE REF TO /AWS1/CL_ASCTARGETTRACKINGCONF /AWS1/CL_ASCTARGETTRACKINGCONF¶

iv_enabled TYPE /AWS1/ASCSCALINGPOLICYENABLED /AWS1/ASCSCALINGPOLICYENABLED¶

io_predictivescalingconf TYPE REF TO /AWS1/CL_ASCPREDICTIVESCACONF /AWS1/CL_ASCPREDICTIVESCACONF¶