Skip to content

/AWS1/IF_AMF=>UPDATEBRANCH()

About UpdateBranch

Updates a branch for an Amplify app.

Method Signature

METHODS /AWS1/IF_AMF~UPDATEBRANCH
  IMPORTING
    !IV_APPID TYPE /AWS1/AMFAPPID OPTIONAL
    !IV_BRANCHNAME TYPE /AWS1/AMFBRANCHNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/AMFDESCRIPTION OPTIONAL
    !IV_FRAMEWORK TYPE /AWS1/AMFFRAMEWORK OPTIONAL
    !IV_STAGE TYPE /AWS1/AMFSTAGE OPTIONAL
    !IV_ENABLENOTIFICATION TYPE /AWS1/AMFENABLENOTIFICATION OPTIONAL
    !IV_ENABLEAUTOBUILD TYPE /AWS1/AMFENABLEAUTOBUILD OPTIONAL
    !IV_ENABLESKEWPROTECTION TYPE /AWS1/AMFENABLESKEWPROTECTION OPTIONAL
    !IT_ENVIRONMENTVARIABLES TYPE /AWS1/CL_AMFENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES OPTIONAL
    !IV_BASICAUTHCREDENTIALS TYPE /AWS1/AMFBASICAUTHCREDENTIALS OPTIONAL
    !IV_ENABLEBASICAUTH TYPE /AWS1/AMFENABLEBASICAUTH OPTIONAL
    !IV_ENABLEPERFORMANCEMODE TYPE /AWS1/AMFENABLEPERFORMANCEMODE OPTIONAL
    !IV_BUILDSPEC TYPE /AWS1/AMFBUILDSPEC OPTIONAL
    !IV_TTL TYPE /AWS1/AMFTTL OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/AMFDISPLAYNAME OPTIONAL
    !IV_ENABLEPULLREQUESTPREVIEW TYPE /AWS1/AMFENABLEPULLREQPREVIEW OPTIONAL
    !IV_PULLREQENVIRONMENTNAME TYPE /AWS1/AMFPULLREQENVIRONMENTN00 OPTIONAL
    !IV_BACKENDENVIRONMENTARN TYPE /AWS1/AMFBACKENDENVIRONMENTARN OPTIONAL
    !IO_BACKEND TYPE REF TO /AWS1/CL_AMFBACKEND OPTIONAL
    !IV_COMPUTEROLEARN TYPE /AWS1/AMFCOMPUTEROLEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amfupdatebranchresult
  RAISING
    /AWS1/CX_AMFBADREQUESTEX
    /AWS1/CX_AMFDEPENDENTSVCFAIL00
    /AWS1/CX_AMFINTERNALFAILUREEX
    /AWS1/CX_AMFNOTFOUNDEXCEPTION
    /AWS1/CX_AMFUNAUTHORIZEDEX
    /AWS1/CX_AMFCLIENTEXC
    /AWS1/CX_AMFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_appid TYPE /AWS1/AMFAPPID /AWS1/AMFAPPID

The unique ID for an Amplify app.

iv_branchname TYPE /AWS1/AMFBRANCHNAME /AWS1/AMFBRANCHNAME

The name of the branch.

Optional arguments:

iv_description TYPE /AWS1/AMFDESCRIPTION /AWS1/AMFDESCRIPTION

The description for the branch.

iv_framework TYPE /AWS1/AMFFRAMEWORK /AWS1/AMFFRAMEWORK

The framework for the branch.

iv_stage TYPE /AWS1/AMFSTAGE /AWS1/AMFSTAGE

Describes the current stage for the branch.

iv_enablenotification TYPE /AWS1/AMFENABLENOTIFICATION /AWS1/AMFENABLENOTIFICATION

Enables notifications for the branch.

iv_enableautobuild TYPE /AWS1/AMFENABLEAUTOBUILD /AWS1/AMFENABLEAUTOBUILD

Enables auto building for the branch.

iv_enableskewprotection TYPE /AWS1/AMFENABLESKEWPROTECTION /AWS1/AMFENABLESKEWPROTECTION

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

it_environmentvariables TYPE /AWS1/CL_AMFENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES

The environment variables for the branch.

iv_basicauthcredentials TYPE /AWS1/AMFBASICAUTHCREDENTIALS /AWS1/AMFBASICAUTHCREDENTIALS

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

iv_enablebasicauth TYPE /AWS1/AMFENABLEBASICAUTH /AWS1/AMFENABLEBASICAUTH

Enables basic authorization for the branch.

iv_enableperformancemode TYPE /AWS1/AMFENABLEPERFORMANCEMODE /AWS1/AMFENABLEPERFORMANCEMODE

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

iv_buildspec TYPE /AWS1/AMFBUILDSPEC /AWS1/AMFBUILDSPEC

The build specification (build spec) for the branch.

iv_ttl TYPE /AWS1/AMFTTL /AWS1/AMFTTL

The content Time to Live (TTL) for the website in seconds.

iv_displayname TYPE /AWS1/AMFDISPLAYNAME /AWS1/AMFDISPLAYNAME

The display name for a branch. This is used as the default domain prefix.

iv_enablepullrequestpreview TYPE /AWS1/AMFENABLEPULLREQPREVIEW /AWS1/AMFENABLEPULLREQPREVIEW

Enables pull request previews for this branch.

iv_pullreqenvironmentname TYPE /AWS1/AMFPULLREQENVIRONMENTN00 /AWS1/AMFPULLREQENVIRONMENTN00

The Amplify environment name for the pull request.

iv_backendenvironmentarn TYPE /AWS1/AMFBACKENDENVIRONMENTARN /AWS1/AMFBACKENDENVIRONMENTARN

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

io_backend TYPE REF TO /AWS1/CL_AMFBACKEND /AWS1/CL_AMFBACKEND

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

iv_computerolearn TYPE /AWS1/AMFCOMPUTEROLEARN /AWS1/AMFCOMPUTEROLEARN

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_amfupdatebranchresult /AWS1/CL_AMFUPDATEBRANCHRESULT

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->updatebranch(
  io_backend = new /aws1/cl_amfbackend( |string| )
  it_environmentvariables = VALUE /aws1/cl_amfenvironmentvaria00=>tt_environmentvariables(
    (
      VALUE /aws1/cl_amfenvironmentvaria00=>ts_environmentvariables_maprow(
        value = new /aws1/cl_amfenvironmentvaria00( |string| )
        key = |string|
      )
    )
  )
  iv_appid = |string|
  iv_backendenvironmentarn = |string|
  iv_basicauthcredentials = |string|
  iv_branchname = |string|
  iv_buildspec = |string|
  iv_computerolearn = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_enableautobuild = ABAP_TRUE
  iv_enablebasicauth = ABAP_TRUE
  iv_enablenotification = ABAP_TRUE
  iv_enableperformancemode = ABAP_TRUE
  iv_enablepullrequestpreview = ABAP_TRUE
  iv_enableskewprotection = ABAP_TRUE
  iv_framework = |string|
  iv_pullreqenvironmentname = |string|
  iv_stage = |string|
  iv_ttl = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_branch = lo_result->get_branch( ).
  IF lo_branch IS NOT INITIAL.
    lv_brancharn = lo_branch->get_brancharn( ).
    lv_branchname = lo_branch->get_branchname( ).
    lv_description = lo_branch->get_description( ).
    LOOP AT lo_branch->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_stage = lo_branch->get_stage( ).
    lv_displayname = lo_branch->get_displayname( ).
    lv_enablenotification = lo_branch->get_enablenotification( ).
    lv_createtime = lo_branch->get_createtime( ).
    lv_updatetime = lo_branch->get_updatetime( ).
    LOOP AT lo_branch->get_environmentvariables( ) into ls_row_1.
      lv_key_1 = ls_row_1-key.
      lo_value_1 = ls_row_1-value.
      IF lo_value_1 IS NOT INITIAL.
        lv_envvalue = lo_value_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_enableautobuild = lo_branch->get_enableautobuild( ).
    lv_enableskewprotection = lo_branch->get_enableskewprotection( ).
    LOOP AT lo_branch->get_customdomains( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_customdomain = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_framework = lo_branch->get_framework( ).
    lv_activejobid = lo_branch->get_activejobid( ).
    lv_totalnumberofjobs = lo_branch->get_totalnumberofjobs( ).
    lv_enablebasicauth = lo_branch->get_enablebasicauth( ).
    lv_enableperformancemode = lo_branch->get_enableperformancemode( ).
    lv_thumbnailurl = lo_branch->get_thumbnailurl( ).
    lv_basicauthcredentials = lo_branch->get_basicauthcredentials( ).
    lv_buildspec = lo_branch->get_buildspec( ).
    lv_ttl = lo_branch->get_ttl( ).
    LOOP AT lo_branch->get_associatedresources( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_associatedresource = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_enablepullrequestprevie = lo_branch->get_enablepullrequestpreview( ).
    lv_pullrequestenvironmentn = lo_branch->get_pullreqenvironmentname( ).
    lv_branchname = lo_branch->get_destinationbranch( ).
    lv_branchname = lo_branch->get_sourcebranch( ).
    lv_backendenvironmentarn = lo_branch->get_backendenvironmentarn( ).
    lo_backend = lo_branch->get_backend( ).
    IF lo_backend IS NOT INITIAL.
      lv_stackarn = lo_backend->get_stackarn( ).
    ENDIF.
    lv_computerolearn = lo_branch->get_computerolearn( ).
  ENDIF.
ENDIF.