Skip to content

/AWS1/IF_ASC=>UPDATEAUTOSCALINGGROUP()

About UpdateAutoScalingGroup

We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.

If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

Note the following about changing DesiredCapacity, MaxSize, or MinSize:

  • If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.

  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.

Method Signature

METHODS /AWS1/IF_ASC~UPDATEAUTOSCALINGGROUP
  IMPORTING
    !IV_AUTOSCALINGGROUPNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_LAUNCHCONFIGURATIONNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IO_LAUNCHTEMPLATE TYPE REF TO /AWS1/CL_ASCLAUNCHTEMPLATESPEC OPTIONAL
    !IO_MIXEDINSTANCESPOLICY TYPE REF TO /AWS1/CL_ASCMIXEDINSTSPOLICY OPTIONAL
    !IV_MINSIZE TYPE /AWS1/ASCAUTOSCGROUPMINSIZE OPTIONAL
    !IV_MAXSIZE TYPE /AWS1/ASCAUTOSCGROUPMAXSIZE OPTIONAL
    !IV_DESIREDCAPACITY TYPE /AWS1/ASCAUTOSCGROUPDESIREDCAP OPTIONAL
    !IV_DEFAULTCOOLDOWN TYPE /AWS1/ASCCOOLDOWN OPTIONAL
    !IT_AVAILABILITYZONES TYPE /AWS1/CL_ASCAZS_W=>TT_AVAILABILITYZONES OPTIONAL
    !IV_HEALTHCHECKTYPE TYPE /AWS1/ASCXMLSTRINGMAXLEN32 OPTIONAL
    !IV_HEALTHCHECKGRACEPERIOD TYPE /AWS1/ASCHEALTHCHECKGRACEPER OPTIONAL
    !IV_PLACEMENTGROUP TYPE /AWS1/ASCUPDATEPLCMTGROUPPARAM OPTIONAL
    !IV_VPCZONEIDENTIFIER TYPE /AWS1/ASCXMLSTRINGMAXLEN5000 OPTIONAL
    !IT_TERMINATIONPOLICIES TYPE /AWS1/CL_ASCTERMINATIONPOL_W=>TT_TERMINATIONPOLICIES OPTIONAL
    !IV_NEWINSTSPROTECTEDFRMSCA00 TYPE /AWS1/ASCINSTANCEPROTECTED OPTIONAL
    !IV_SERVICELINKEDROLEARN TYPE /AWS1/ASCRESOURCENAME OPTIONAL
    !IV_MAXINSTANCELIFETIME TYPE /AWS1/ASCMAXINSTANCELIFETIME OPTIONAL
    !IV_CAPACITYREBALANCE TYPE /AWS1/ASCCAPREBALANCEENABLED OPTIONAL
    !IV_CONTEXT TYPE /AWS1/ASCCONTEXT OPTIONAL
    !IV_DESIREDCAPACITYTYPE TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_DEFAULTINSTANCEWARMUP TYPE /AWS1/ASCDEFAULTINSTANCEWARMUP OPTIONAL
    !IO_INSTANCEMAINTENANCEPOLICY TYPE REF TO /AWS1/CL_ASCINSTMAINTENANCEPLY OPTIONAL
    !IO_AZDISTRIBUTION TYPE REF TO /AWS1/CL_ASCAZDISTRIBUTION OPTIONAL
    !IO_AZIMPAIRMENTPOLICY TYPE REF TO /AWS1/CL_ASCAZIMPAIRMENTPOLICY OPTIONAL
    !IV_SKIPZONALSHIFTVALIDATION TYPE /AWS1/ASCSKIPZONALSHIFTVALID00 OPTIONAL
    !IO_CAPACITYRESERVATIONSPEC TYPE REF TO /AWS1/CL_ASCCAPACITYRSVPEC OPTIONAL
    !IO_INSTANCELIFECYCLEPOLICY TYPE REF TO /AWS1/CL_ASCINSTANCELCPOLICY OPTIONAL
  RAISING
    /AWS1/CX_ASCRESRCCONTIONFAULT
    /AWS1/CX_ASCSCAACTIVITYINPRG00
    /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.

Optional arguments:

iv_launchconfigurationname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.

io_launchtemplate TYPE REF TO /AWS1/CL_ASCLAUNCHTEMPLATESPEC /AWS1/CL_ASCLAUNCHTEMPLATESPEC

The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.

io_mixedinstancespolicy TYPE REF TO /AWS1/CL_ASCMIXEDINSTSPOLICY /AWS1/CL_ASCMIXEDINSTSPOLICY

The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.

iv_minsize TYPE /AWS1/ASCAUTOSCGROUPMINSIZE /AWS1/ASCAUTOSCGROUPMINSIZE

The minimum size of the Auto Scaling group.

iv_maxsize TYPE /AWS1/ASCAUTOSCGROUPMAXSIZE /AWS1/ASCAUTOSCGROUPMAXSIZE

The maximum size of the Auto Scaling group.

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

iv_desiredcapacity TYPE /AWS1/ASCAUTOSCGROUPDESIREDCAP /AWS1/ASCAUTOSCGROUPDESIREDCAP

The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

iv_defaultcooldown TYPE /AWS1/ASCCOOLDOWN /AWS1/ASCCOOLDOWN

Only needed if you use simple scaling policies.

The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

it_availabilityzones TYPE /AWS1/CL_ASCAZS_W=>TT_AVAILABILITYZONES TT_AVAILABILITYZONES

One or more Availability Zones for the group.

iv_healthchecktype TYPE /AWS1/ASCXMLSTRINGMAXLEN32 /AWS1/ASCXMLSTRINGMAXLEN32

A comma-separated value string of one or more health check types.

The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Only specify EC2 if you must clear a value that was previously set.

iv_healthcheckgraceperiod TYPE /AWS1/ASCHEALTHCHECKGRACEPER /AWS1/ASCHEALTHCHECKGRACEPER

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

iv_placementgroup TYPE /AWS1/ASCUPDATEPLCMTGROUPPARAM /AWS1/ASCUPDATEPLCMTGROUPPARAM

The name of an existing placement group into which to launch your instances. To remove the placement group setting, pass an empty string for placement-group. For more information about placement groups, see Placement groups in the Amazon EC2 User Guide.

A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

iv_vpczoneidentifier TYPE /AWS1/ASCXMLSTRINGMAXLEN5000 /AWS1/ASCXMLSTRINGMAXLEN5000

A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.

it_terminationpolicies TYPE /AWS1/CL_ASCTERMINATIONPOL_W=>TT_TERMINATIONPOLICIES TT_TERMINATIONPOLICIES

A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias

iv_newinstsprotectedfrmsca00 TYPE /AWS1/ASCINSTANCEPROTECTED /AWS1/ASCINSTANCEPROTECTED

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

iv_servicelinkedrolearn TYPE /AWS1/ASCRESOURCENAME /AWS1/ASCRESOURCENAME

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.

iv_maxinstancelifetime TYPE /AWS1/ASCMAXINSTANCELIFETIME /AWS1/ASCMAXINSTANCELIFETIME

The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.

iv_capacityrebalance TYPE /AWS1/ASCCAPREBALANCEENABLED /AWS1/ASCCAPREBALANCEENABLED

Enables or disables Capacity Rebalancing. If Capacity Rebalancing is disabled, proactive replacement of at-risk Spot Instances does not occur. For more information, see Capacity Rebalancing in Auto Scaling to replace at-risk Spot Instances in the Amazon EC2 Auto Scaling User Guide.

To suspend rebalancing across Availability Zones, use the SuspendProcesses API.

iv_context TYPE /AWS1/ASCCONTEXT /AWS1/ASCCONTEXT

Reserved.

iv_desiredcapacitytype TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.

Valid values: units | vcpu | memory-mib

iv_defaultinstancewarmup TYPE /AWS1/ASCDEFAULTINSTANCEWARMUP /AWS1/ASCDEFAULTINSTANCEWARMUP

The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.

io_instancemaintenancepolicy TYPE REF TO /AWS1/CL_ASCINSTMAINTENANCEPLY /AWS1/CL_ASCINSTMAINTENANCEPLY

An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.

io_azdistribution TYPE REF TO /AWS1/CL_ASCAZDISTRIBUTION /AWS1/CL_ASCAZDISTRIBUTION

The instance capacity distribution across Availability Zones.

io_azimpairmentpolicy TYPE REF TO /AWS1/CL_ASCAZIMPAIRMENTPOLICY /AWS1/CL_ASCAZIMPAIRMENTPOLICY

The policy for Availability Zone impairment.

iv_skipzonalshiftvalidation TYPE /AWS1/ASCSKIPZONALSHIFTVALID00 /AWS1/ASCSKIPZONALSHIFTVALID00

If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.

io_capacityreservationspec TYPE REF TO /AWS1/CL_ASCCAPACITYRSVPEC /AWS1/CL_ASCCAPACITYRSVPEC

The capacity reservation specification for the Auto Scaling group.

io_instancelifecyclepolicy TYPE REF TO /AWS1/CL_ASCINSTANCELCPOLICY /AWS1/CL_ASCINSTANCELCPOLICY

The instance lifecycle policy for the Auto Scaling group. Use this to add, modify, or remove lifecycle policies that control instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when to preserve instances for manual intervention.

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.

lo_client->updateautoscalinggroup(
  io_azdistribution = new /aws1/cl_ascazdistribution( |string| )
  io_azimpairmentpolicy = new /aws1/cl_ascazimpairmentpolicy(
    iv_impairedzonehealthcheck00 = |string|
    iv_zonalshiftenabled = ABAP_TRUE
  )
  io_capacityreservationspec = new /aws1/cl_asccapacityrsvpec(
    io_capacityreservationtarget = new /aws1/cl_asccapreservationtgt(
      it_capacityreservationids = VALUE /aws1/cl_asccapreservationid00=>tt_capacityreservationids(
        ( new /aws1/cl_asccapreservationid00( |string| ) )
      )
      it_capreservationresrcgrarns = VALUE /aws1/cl_asccapreservationre00=>tt_capreservationresrcgrparns(
        ( new /aws1/cl_asccapreservationre00( |string| ) )
      )
    )
    iv_capreservationpreference = |string|
  )
  io_instancelifecyclepolicy = new /aws1/cl_ascinstancelcpolicy( new /aws1/cl_ascretentiontriggers( |string| ) )
  io_instancemaintenancepolicy = new /aws1/cl_ascinstmaintenanceply(
    iv_maxhealthypercentage = 123
    iv_minhealthypercentage = 123
  )
  io_launchtemplate = new /aws1/cl_asclaunchtemplatespec(
    iv_launchtemplateid = |string|
    iv_launchtemplatename = |string|
    iv_version = |string|
  )
  io_mixedinstancespolicy = new /aws1/cl_ascmixedinstspolicy(
    io_instancesdistribution = new /aws1/cl_ascinstsdistribution(
      iv_ondemandallocstrategy = |string|
      iv_ondemandbasecapacity = 123
      iv_ondempercentageabovebas00 = 123
      iv_spotallocationstrategy = |string|
      iv_spotinstancepools = 123
      iv_spotmaxprice = |string|
    )
    io_launchtemplate = new /aws1/cl_asclaunchtemplate(
      io_launchtemplatespec = new /aws1/cl_asclaunchtemplatespec(
        iv_launchtemplateid = |string|
        iv_launchtemplatename = |string|
        iv_version = |string|
      )
      it_overrides = VALUE /aws1/cl_asclaunchtmploverri00=>tt_overrides(
        (
          new /aws1/cl_asclaunchtmploverri00(
            io_instancerequirements = new /aws1/cl_ascinstrequirements(
              io_acceleratorcount = new /aws1/cl_ascacceleratorcntreq(
                iv_max = 123
                iv_min = 123
              )
              io_acceleratortotalmemorymib = new /aws1/cl_ascacceleratortotal00(
                iv_max = 123
                iv_min = 123
              )
              io_baselineebsbandwidthmbps = new /aws1/cl_ascbaselineebsbandw00(
                iv_max = 123
                iv_min = 123
              )
              io_baselineperformancefact00 = new /aws1/cl_ascbaselineperforma00(
                io_cpu = new /aws1/cl_asccpuperformancefa00(
                  it_references = VALUE /aws1/cl_ascperformancefacto00=>tt_performancefactorreferenc00(
                    ( new /aws1/cl_ascperformancefacto00( |string| ) )
                  )
                )
              )
              io_memorygibpervcpu = new /aws1/cl_ascmemorygibpervcpu00(
                iv_max = '0.1'
                iv_min = '0.1'
              )
              io_memorymib = new /aws1/cl_ascmemorymibrequest(
                iv_max = 123
                iv_min = 123
              )
              io_networkbandwidthgbps = new /aws1/cl_ascnetworkbandwidth00(
                iv_max = '0.1'
                iv_min = '0.1'
              )
              io_networkinterfacecount = new /aws1/cl_ascnetworkinterface00(
                iv_max = 123
                iv_min = 123
              )
              io_totallocalstoragegb = new /aws1/cl_asctotallocalstrggb00(
                iv_max = '0.1'
                iv_min = '0.1'
              )
              io_vcpucount = new /aws1/cl_ascvcpucountrequest(
                iv_max = 123
                iv_min = 123
              )
              it_acceleratormanufacturers = VALUE /aws1/cl_ascacceleratormanuf00=>tt_acceleratormanufacturers(
                ( new /aws1/cl_ascacceleratormanuf00( |string| ) )
              )
              it_acceleratornames = VALUE /aws1/cl_ascacceleratornames_w=>tt_acceleratornames(
                ( new /aws1/cl_ascacceleratornames_w( |string| ) )
              )
              it_acceleratortypes = VALUE /aws1/cl_ascacceleratortypes_w=>tt_acceleratortypes(
                ( new /aws1/cl_ascacceleratortypes_w( |string| ) )
              )
              it_allowedinstancetypes = VALUE /aws1/cl_ascallowedinsttypes_w=>tt_allowedinstancetypes(
                ( new /aws1/cl_ascallowedinsttypes_w( |string| ) )
              )
              it_cpumanufacturers = VALUE /aws1/cl_asccpumanufacturers_w=>tt_cpumanufacturers(
                ( new /aws1/cl_asccpumanufacturers_w( |string| ) )
              )
              it_excludedinstancetypes = VALUE /aws1/cl_ascexcludedinsttype00=>tt_excludedinstancetypes(
                ( new /aws1/cl_ascexcludedinsttype00( |string| ) )
              )
              it_instancegenerations = VALUE /aws1/cl_ascinstgenerations_w=>tt_instancegenerations(
                ( new /aws1/cl_ascinstgenerations_w( |string| ) )
              )
              it_localstoragetypes = VALUE /aws1/cl_asclocalstrgtypes_w=>tt_localstoragetypes(
                ( new /aws1/cl_asclocalstrgtypes_w( |string| ) )
              )
              iv_baremetal = |string|
              iv_burstableperformance = |string|
              iv_localstorage = |string|
              iv_maxspotpriceaspercentag00 = 123
              iv_ondemmaxpricepercentage00 = 123
              iv_requirehibernatesupport = ABAP_TRUE
              iv_spotmaxpricepercentageo00 = 123
            )
            io_launchtemplatespec = new /aws1/cl_asclaunchtemplatespec(
              iv_launchtemplateid = |string|
              iv_launchtemplatename = |string|
              iv_version = |string|
            )
            iv_imageid = |string|
            iv_instancetype = |string|
            iv_weightedcapacity = |string|
          )
        )
      )
    )
  )
  it_availabilityzones = VALUE /aws1/cl_ascazs_w=>tt_availabilityzones(
    ( new /aws1/cl_ascazs_w( |string| ) )
  )
  it_terminationpolicies = VALUE /aws1/cl_ascterminationpol_w=>tt_terminationpolicies(
    ( new /aws1/cl_ascterminationpol_w( |string| ) )
  )
  iv_autoscalinggroupname = |string|
  iv_capacityrebalance = ABAP_TRUE
  iv_context = |string|
  iv_defaultcooldown = 123
  iv_defaultinstancewarmup = 123
  iv_desiredcapacity = 123
  iv_desiredcapacitytype = |string|
  iv_healthcheckgraceperiod = 123
  iv_healthchecktype = |string|
  iv_launchconfigurationname = |string|
  iv_maxinstancelifetime = 123
  iv_maxsize = 123
  iv_minsize = 123
  iv_newinstsprotectedfrmsca00 = ABAP_TRUE
  iv_placementgroup = |string|
  iv_servicelinkedrolearn = |string|
  iv_skipzonalshiftvalidation = ABAP_TRUE
  iv_vpczoneidentifier = |string|
).

To update an Auto Scaling group

This example updates multiple properties at the same time.

lo_client->updateautoscalinggroup(
  io_launchtemplate = new /aws1/cl_asclaunchtemplatespec(
    iv_launchtemplatename = |my-template-for-auto-scaling|
    iv_version = |2|
  )
  iv_autoscalinggroupname = |my-auto-scaling-group|
  iv_maxsize = 5
  iv_minsize = 1
  iv_newinstsprotectedfrmsca00 = ABAP_TRUE
).