AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Amplify UpdateApp API operation.

Syntax

Update-AMPApp
-AppId <String>
-AccessToken <String>
-AutoBranchCreationPattern <String[]>
-AutoBranchCreationConfig_BasicAuthCredential <String>
-BasicAuthCredential <String>
-AutoBranchCreationConfig_BuildSpec <String>
-BuildSpec <String>
-ComputeRoleArn <String>
-CustomHeader <String>
-CustomRule <CustomRule[]>
-Description <String>
-EnableAutoBranchCreation <Boolean>
-AutoBranchCreationConfig_EnableAutoBuild <Boolean>
-AutoBranchCreationConfig_EnableBasicAuth <Boolean>
-EnableBasicAuth <Boolean>
-EnableBranchAutoBuild <Boolean>
-EnableBranchAutoDeletion <Boolean>
-AutoBranchCreationConfig_EnablePerformanceMode <Boolean>
-AutoBranchCreationConfig_EnablePullRequestPreview <Boolean>
-AutoBranchCreationConfig_EnvironmentVariable <Hashtable>
-EnvironmentVariable <Hashtable>
-AutoBranchCreationConfig_Framework <String>
-IamServiceRoleArn <String>
-Name <String>
-OauthToken <String>
-Platform <Platform>
-AutoBranchCreationConfig_PullRequestEnvironmentName <String>
-Repository <String>
-AutoBranchCreationConfig_Stage <Stage>
-CacheConfig_Type <CacheConfigType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonAmplifyConfig>

Description

Updates an existing Amplify app.

Parameters

-AccessToken <String>
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 .
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppId <String>
The unique ID for an Amplify app.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AutoBranchCreationConfig_BasicAuthCredential <String>
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoBranchCreationConfig_BasicAuthCredentials
-AutoBranchCreationConfig_BuildSpec <String>
The build specification (build spec) for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_EnableAutoBuild <Boolean>
Enables auto building for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_EnableBasicAuth <Boolean>
Enables basic authorization for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_EnablePerformanceMode <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_EnablePullRequestPreview <Boolean>
Enables pull request previews for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_EnvironmentVariable <Hashtable>
The environment variables for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoBranchCreationConfig_EnvironmentVariables
-AutoBranchCreationConfig_Framework <String>
The framework for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_PullRequestEnvironmentName <String>
The Amplify environment name for the pull request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationConfig_Stage <Stage>
Describes the current stage for the autocreated branch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoBranchCreationPattern <String[]>
Describes the automated branch creation glob patterns for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoBranchCreationPatterns
-BasicAuthCredential <String>
The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBasicAuthCredentials
-BuildSpec <String>
The build specification (build spec) for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheConfig_Type <CacheConfigType>
The type of cache configuration to use for an Amplify app.The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAmplifyConfig>
Amazon.PowerShell.Cmdlets.AMP.AmazonAmplifyClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role to assign to 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomHeader <String>
The custom HTTP headers for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomHeaders
-CustomRule <CustomRule[]>
The custom redirect and rewrite rules for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomRules
-Description <String>
The description for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableAutoBranchCreation <Boolean>
Enables automated branch creation for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableBasicAuth <Boolean>
Enables basic authorization for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableBranchAutoBuild <Boolean>
Enables branch auto-building for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnableBranchAutoDeletion <Boolean>
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentVariable <Hashtable>
The environment variables for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironmentVariables
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamServiceRoleArn <String>
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OauthToken <String>
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 .
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Platform <Platform>
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.If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Repository <String>
The name of the Git repository for an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'App'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UpdateAppResponse). Specifying the name of a property of type Amazon.Amplify.Model.UpdateAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Amplify.Model.App or Amazon.Amplify.Model.UpdateAppResponse
This cmdlet returns an Amazon.Amplify.Model.App object. The service call response (type Amazon.Amplify.Model.UpdateAppResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z