Skip to content

/AWS1/CL_AMF=>UPDATEAPP()

About UpdateApp

Updates an existing Amplify app.

Method Signature

IMPORTING

Required arguments:

IV_APPID TYPE /AWS1/AMFAPPID /AWS1/AMFAPPID

The unique ID for an Amplify app.

Optional arguments:

IV_NAME TYPE /AWS1/AMFNAME /AWS1/AMFNAME

The name for an Amplify app.

IV_DESCRIPTION TYPE /AWS1/AMFDESCRIPTION /AWS1/AMFDESCRIPTION

The description for an Amplify app.

IV_PLATFORM TYPE /AWS1/AMFPLATFORM /AWS1/AMFPLATFORM

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

IV_IAMSERVICEROLEARN TYPE /AWS1/AMFSERVICEROLEARN /AWS1/AMFSERVICEROLEARN

The AWS Identity and Access Management (IAM) service role for an Amplify app.

IT_ENVIRONMENTVARIABLES TYPE /AWS1/CL_AMFENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES

The environment variables for an Amplify app.

IV_ENABLEBRANCHAUTOBUILD TYPE /AWS1/AMFENABLEAUTOBUILD /AWS1/AMFENABLEAUTOBUILD

Enables branch auto-building for an Amplify app.

IV_ENABLEBRANCHAUTODELETION TYPE /AWS1/AMFENBBRANCHAUTODELETION /AWS1/AMFENBBRANCHAUTODELETION

Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.

IV_ENABLEBASICAUTH TYPE /AWS1/AMFENABLEBASICAUTH /AWS1/AMFENABLEBASICAUTH

Enables basic authorization for an Amplify app.

IV_BASICAUTHCREDENTIALS TYPE /AWS1/AMFBASICAUTHCREDENTIALS /AWS1/AMFBASICAUTHCREDENTIALS

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

IT_CUSTOMRULES TYPE /AWS1/CL_AMFCUSTOMRULE=>TT_CUSTOMRULES TT_CUSTOMRULES

The custom redirect and rewrite rules for an Amplify app.

IV_BUILDSPEC TYPE /AWS1/AMFBUILDSPEC /AWS1/AMFBUILDSPEC

The build specification (build spec) for an Amplify app.

IV_CUSTOMHEADERS TYPE /AWS1/AMFCUSTOMHEADERS /AWS1/AMFCUSTOMHEADERS

The custom HTTP headers for an Amplify app.

IV_ENABLEAUTOBRANCHCREATION TYPE /AWS1/AMFENBAUTOBRANCHCREATION /AWS1/AMFENBAUTOBRANCHCREATION

Enables automated branch creation for an Amplify app.

IT_AUTOBRANCHCREATIONPATS TYPE /AWS1/CL_AMFAUTOBRANCHCREATI00=>TT_AUTOBRANCHCREATIONPATTERNS TT_AUTOBRANCHCREATIONPATTERNS

Describes the automated branch creation glob patterns for an Amplify app.

IO_AUTOBRANCHCREATIONCONFIG TYPE REF TO /AWS1/CL_AMFAUTOBRANCHCREATI01 /AWS1/CL_AMFAUTOBRANCHCREATI01

The automated branch creation configuration for an Amplify app.

IV_REPOSITORY TYPE /AWS1/AMFREPOSITORY /AWS1/AMFREPOSITORY

The name of the Git repository for an Amplify app.

IV_OAUTHTOKEN TYPE /AWS1/AMFOAUTHTOKEN /AWS1/AMFOAUTHTOKEN

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.

To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

IV_ACCESSTOKEN TYPE /AWS1/AMFACCESSTOKEN /AWS1/AMFACCESSTOKEN

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_AMFUPDATEAPPRESULT /AWS1/CL_AMFUPDATEAPPRESULT