/AWS1/IF_DPL=>UPDATEDEPLOYMENTGROUP()

About UpdateDeploymentGroup

Changes information about a deployment group.

Method Signature

IMPORTING

Required arguments:

iv_applicationname TYPE /AWS1/DPLAPPLICATIONNAME /AWS1/DPLAPPLICATIONNAME

The application name that corresponds to the deployment group to update.

iv_currentdeploymentgrpname TYPE /AWS1/DPLDEPLOYMENTGROUPNAME /AWS1/DPLDEPLOYMENTGROUPNAME

The current name of the deployment group.

Optional arguments:

iv_newdeploymentgroupname TYPE /AWS1/DPLDEPLOYMENTGROUPNAME /AWS1/DPLDEPLOYMENTGROUPNAME

The new name of the deployment group, if you want to change it.

iv_deploymentconfigname TYPE /AWS1/DPLDEPLOYMENTCONFIGNAME /AWS1/DPLDEPLOYMENTCONFIGNAME

The replacement deployment configuration name to use, if you want to change it.

it_ec2tagfilters TYPE /AWS1/CL_DPLEC2TAGFILTER=>TT_EC2TAGFILTERLIST TT_EC2TAGFILTERLIST

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

it_onpremisesinsttagfilters TYPE /AWS1/CL_DPLTAGFILTER=>TT_TAGFILTERLIST TT_TAGFILTERLIST

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

it_autoscalinggroups TYPE /AWS1/CL_DPLAUTOSCGRPNAMELST_W=>TT_AUTOSCALINGGROUPNAMELIST TT_AUTOSCALINGGROUPNAMELIST

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

• To keep the Auto Scaling groups, enter their names or do not specify this parameter.

• To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout" in the CodeDeploy User Guide.

iv_servicerolearn TYPE /AWS1/DPLROLE /AWS1/DPLROLE

A replacement ARN for the service role, if you want to change it.

it_triggerconfigurations TYPE /AWS1/CL_DPLTRIGGERCONFIG=>TT_TRIGGERCONFIGLIST TT_TRIGGERCONFIGLIST

Information about triggers to change when the deployment group is updated. For examples, see Edit a Trigger in a CodeDeploy Deployment Group in the CodeDeploy User Guide.

io_alarmconfiguration TYPE REF TO /AWS1/CL_DPLALARMCONFIGURATION /AWS1/CL_DPLALARMCONFIGURATION

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

io_autorollbackconfiguration TYPE REF TO /AWS1/CL_DPLAUTOROLLBACKCONF /AWS1/CL_DPLAUTOROLLBACKCONF

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

iv_outdatedinstancesstrategy TYPE /AWS1/DPLOUTDATEDINSTSSTRATEGY /AWS1/DPLOUTDATEDINSTSSTRATEGY

Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.

If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances.

If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.

io_deploymentstyle TYPE REF TO /AWS1/CL_DPLDEPLOYMENTSTYLE /AWS1/CL_DPLDEPLOYMENTSTYLE

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

io_bluegreendeploymentconf TYPE REF TO /AWS1/CL_DPLBLUEGREENDEPLOYM00 /AWS1/CL_DPLBLUEGREENDEPLOYM00

Information about blue/green deployment options for a deployment group.

io_loadbalancerinfo TYPE REF TO /AWS1/CL_DPLLOADBALANCERINFO /AWS1/CL_DPLLOADBALANCERINFO

Information about the load balancer used in a deployment.

io_ec2tagset TYPE REF TO /AWS1/CL_DPLEC2TAGSET /AWS1/CL_DPLEC2TAGSET

Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

it_ecsservices TYPE /AWS1/CL_DPLECSSERVICE=>TT_ECSSERVICELIST TT_ECSSERVICELIST

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format :.

io_onpremisestagset TYPE REF TO /AWS1/CL_DPLONPREMISESTAGSET /AWS1/CL_DPLONPREMISESTAGSET

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

iv_terminationhookenabled TYPE /AWS1/DPLNULLABLEBOOLEAN /AWS1/DPLNULLABLEBOOLEAN

This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide.

Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you update a deployment group. When this hook is installed, CodeDeploy will perform termination deployments.

For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_dplupdeploymentgrout /AWS1/CL_DPLUPDEPLOYMENTGROUT

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->/aws1/if_dpl~updatedeploymentgroup(
  io_alarmconfiguration = new /aws1/cl_dplalarmconfiguration(
    it_alarms = VALUE /aws1/cl_dplalarm=>tt_alarmlist(
      ( new /aws1/cl_dplalarm( |string| ) )
    )
    iv_enabled = ABAP_TRUE
    iv_ignorepollalarmfailure = ABAP_TRUE
  )
  io_autorollbackconfiguration = new /aws1/cl_dplautorollbackconf(
    it_events = VALUE /aws1/cl_dplautorollbackevts00=>tt_autorollbackeventslist(
      ( new /aws1/cl_dplautorollbackevts00( |string| ) )
    )
    iv_enabled = ABAP_TRUE
  )
  io_bluegreendeploymentconf = new /aws1/cl_dplbluegreendeploym00(
    io_deploymentreadyoption = new /aws1/cl_dpldeploymentreadyo00(
      iv_actionontimeout = |string|
      iv_waittimeinminutes = 123
    )
    io_greenfleetprovoption = new /aws1/cl_dplgreenfleetprovop00( |string| )
    io_terminateblueinstsondep00 = new /aws1/cl_dplblueinstterminat00(
      iv_action = |string|
      iv_terminationwaittimeinmins = 123
    )
  )
  io_deploymentstyle = new /aws1/cl_dpldeploymentstyle(
    iv_deploymentoption = |string|
    iv_deploymenttype = |string|
  )
  io_ec2tagset = new /aws1/cl_dplec2tagset(
    it_ec2tagsetlist = VALUE /aws1/cl_dplec2tagfilter=>tt_ec2tagsetlist(
      (
        VALUE /aws1/cl_dplec2tagfilter=>tt_ec2tagfilterlist(
          (
            new /aws1/cl_dplec2tagfilter(
              iv_key = |string|
              iv_type = |string|
              iv_value = |string|
            )
          )
        )
      )
    )
  )
  io_loadbalancerinfo = new /aws1/cl_dplloadbalancerinfo(
    it_elbinfolist = VALUE /aws1/cl_dplelbinfo=>tt_elbinfolist(
      ( new /aws1/cl_dplelbinfo( |string| ) )
    )
    it_targetgroupinfolist = VALUE /aws1/cl_dpltargetgroupinfo=>tt_targetgroupinfolist(
      ( new /aws1/cl_dpltargetgroupinfo( |string| ) )
    )
    it_targetgrouppairinfolist = VALUE /aws1/cl_dpltgtgrouppairinfo=>tt_targetgrouppairinfolist(
      (
        new /aws1/cl_dpltgtgrouppairinfo(
          io_prodtrafficroute = new /aws1/cl_dpltrafficroute(
            it_listenerarns = VALUE /aws1/cl_dpllistenerarnlist_w=>tt_listenerarnlist(
              ( new /aws1/cl_dpllistenerarnlist_w( |string| ) )
            )
          )
          io_testtrafficroute = new /aws1/cl_dpltrafficroute(
            it_listenerarns = VALUE /aws1/cl_dpllistenerarnlist_w=>tt_listenerarnlist(
              ( new /aws1/cl_dpllistenerarnlist_w( |string| ) )
            )
          )
          it_targetgroups = VALUE /aws1/cl_dpltargetgroupinfo=>tt_targetgroupinfolist(
            ( new /aws1/cl_dpltargetgroupinfo( |string| ) )
          )
        )
      )
    )
  )
  io_onpremisestagset = new /aws1/cl_dplonpremisestagset(
    it_onpremisestagsetlist = VALUE /aws1/cl_dpltagfilter=>tt_onpremisestagsetlist(
      (
        VALUE /aws1/cl_dpltagfilter=>tt_tagfilterlist(
          (
            new /aws1/cl_dpltagfilter(
              iv_key = |string|
              iv_type = |string|
              iv_value = |string|
            )
          )
        )
      )
    )
  )
  it_autoscalinggroups = VALUE /aws1/cl_dplautoscgrpnamelst_w=>tt_autoscalinggroupnamelist(
    ( new /aws1/cl_dplautoscgrpnamelst_w( |string| ) )
  )
  it_ec2tagfilters = VALUE /aws1/cl_dplec2tagfilter=>tt_ec2tagfilterlist(
    (
      new /aws1/cl_dplec2tagfilter(
        iv_key = |string|
        iv_type = |string|
        iv_value = |string|
      )
    )
  )
  it_ecsservices = VALUE /aws1/cl_dplecsservice=>tt_ecsservicelist(
    (
      new /aws1/cl_dplecsservice(
        iv_clustername = |string|
        iv_servicename = |string|
      )
    )
  )
  it_onpremisesinsttagfilters = VALUE /aws1/cl_dpltagfilter=>tt_tagfilterlist(
    (
      new /aws1/cl_dpltagfilter(
        iv_key = |string|
        iv_type = |string|
        iv_value = |string|
      )
    )
  )
  it_triggerconfigurations = VALUE /aws1/cl_dpltriggerconfig=>tt_triggerconfiglist(
    (
      new /aws1/cl_dpltriggerconfig(
        it_triggerevents = VALUE /aws1/cl_dpltriggerevttypels00=>tt_triggereventtypelist(
          ( new /aws1/cl_dpltriggerevttypels00( |string| ) )
        )
        iv_triggername = |string|
        iv_triggertargetarn = |string|
      )
    )
  )
  iv_applicationname = |string|
  iv_currentdeploymentgrpname = |string|
  iv_deploymentconfigname = |string|
  iv_newdeploymentgroupname = |string|
  iv_outdatedinstancesstrategy = |string|
  iv_servicerolearn = |string|
  iv_terminationhookenabled = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_hooksnotcleanedup( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_autoscalinggroupname = lo_row_1->get_name( ).
      lv_autoscalinggrouphook = lo_row_1->get_hook( ).
      lv_autoscalinggrouphook = lo_row_1->get_terminationhook( ).
    ENDIF.
  ENDLOOP.
ENDIF.