/AWS1/CL_AMF=>UPDATEBRANCH()

About UpdateBranch

Updates a branch for an Amplify app.

Method Signature

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.

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_AMFUPDATEBRANCHRESULT /AWS1/CL_AMFUPDATEBRANCHRESULT