Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

update-app

Description

Updates an existing Amplify app.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-app
--app-id <value>
[--name <value>]
[--description <value>]
[--platform <value>]
[--iam-service-role-arn <value>]
[--environment-variables <value>]
[--enable-branch-auto-build | --no-enable-branch-auto-build]
[--enable-branch-auto-deletion | --no-enable-branch-auto-deletion]
[--enable-basic-auth | --no-enable-basic-auth]
[--basic-auth-credentials <value>]
[--custom-rules <value>]
[--build-spec <value>]
[--enable-auto-branch-creation | --no-enable-auto-branch-creation]
[--auto-branch-creation-patterns <value>]
[--auto-branch-creation-config <value>]
[--repository <value>]
[--oauth-token <value>]
[--access-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique ID for an Amplify app.

--name (string)

The name for an Amplify app.

--description (string)

The description for an Amplify app.

--platform (string)

The platform for an Amplify app.

Possible values:

  • WEB

--iam-service-role-arn (string)

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

--environment-variables (map)

The environment variables for an Amplify app.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--enable-branch-auto-build | --no-enable-branch-auto-build (boolean)

Enables branch auto-building for an Amplify app.

--enable-branch-auto-deletion | --no-enable-branch-auto-deletion (boolean)

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

--enable-basic-auth | --no-enable-basic-auth (boolean)

Enables basic authorization for an Amplify app.

--basic-auth-credentials (string)

The basic authorization credentials for an Amplify app.

--custom-rules (list)

The custom redirect and rewrite rules for an Amplify app.

(structure)

Describes a custom rewrite or redirect rule.

source -> (string)

The source pattern for a URL rewrite or redirect rule.

target -> (string)

The target pattern for a URL rewrite or redirect rule.

status -> (string)

The status code for a URL rewrite or redirect rule.

200

Represents a 200 rewrite rule.

301

Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

302

Represents a 302 temporary redirect rule.

404

Represents a 404 redirect rule.

404-200

Represents a 404 rewrite rule.

condition -> (string)

The condition for a URL rewrite or redirect rule, such as a country code.

Shorthand Syntax:

source=string,target=string,status=string,condition=string ...

JSON Syntax:

[
  {
    "source": "string",
    "target": "string",
    "status": "string",
    "condition": "string"
  }
  ...
]

--build-spec (string)

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

--enable-auto-branch-creation | --no-enable-auto-branch-creation (boolean)

Enables automated branch creation for the Amplify app.

--auto-branch-creation-patterns (list)

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

(string)

Syntax:

"string" "string" ...

--auto-branch-creation-config (structure)

The automated branch creation configuration for the Amplify app.

stage -> (string)

Describes the current stage for the autocreated branch.

framework -> (string)

The framework for the autocreated branch.

enableAutoBuild -> (boolean)

Enables auto building for the autocreated branch.

environmentVariables -> (map)

The environment variables for the autocreated branch.

key -> (string)

value -> (string)

basicAuthCredentials -> (string)

The basic authorization credentials for the autocreated branch.

enableBasicAuth -> (boolean)

Enables basic authorization for the autocreated branch.

enablePerformanceMode -> (boolean)

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

buildSpec -> (string)

The build specification (build spec) for the autocreated branch.

enablePullRequestPreview -> (boolean)

Enables pull request preview for the autocreated branch.

pullRequestEnvironmentName -> (string)

The Amplify environment name for the pull request.

Shorthand Syntax:

stage=string,framework=string,enableAutoBuild=boolean,environmentVariables={KeyName1=string,KeyName2=string},basicAuthCredentials=string,enableBasicAuth=boolean,enablePerformanceMode=boolean,buildSpec=string,enablePullRequestPreview=boolean,pullRequestEnvironmentName=string

JSON Syntax:

{
  "stage": "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST",
  "framework": "string",
  "enableAutoBuild": true|false,
  "environmentVariables": {"string": "string"
    ...},
  "basicAuthCredentials": "string",
  "enableBasicAuth": true|false,
  "enablePerformanceMode": true|false,
  "buildSpec": "string",
  "enablePullRequestPreview": true|false,
  "pullRequestEnvironmentName": "string"
}

--repository (string)

The name of the repository for an Amplify app

--oauth-token (string)

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

--access-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

app -> (structure)

Represents the updated Amplify app.

appId -> (string)

The unique ID of the Amplify app.

appArn -> (string)

The Amazon Resource Name (ARN) of the Amplify app.

name -> (string)

The name for the Amplify app.

tags -> (map)

The tag for the Amplify app.

key -> (string)

value -> (string)

description -> (string)

The description for the Amplify app.

repository -> (string)

The repository for the Amplify app.

platform -> (string)

The platform for the Amplify app.

createTime -> (timestamp)

Creates a date and time for the Amplify app.

updateTime -> (timestamp)

Updates the date and time for the Amplify app.

iamServiceRoleArn -> (string)

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

environmentVariables -> (map)

The environment variables for the Amplify app.

key -> (string)

value -> (string)

defaultDomain -> (string)

The default domain for the Amplify app.

enableBranchAutoBuild -> (boolean)

Enables the auto-building of branches for the Amplify app.

enableBranchAutoDeletion -> (boolean)

Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

enableBasicAuth -> (boolean)

Enables basic authorization for the Amplify app's branches.

basicAuthCredentials -> (string)

The basic authorization credentials for branches for the Amplify app.

customRules -> (list)

Describes the custom redirect and rewrite rules for the Amplify app.

(structure)

Describes a custom rewrite or redirect rule.

source -> (string)

The source pattern for a URL rewrite or redirect rule.

target -> (string)

The target pattern for a URL rewrite or redirect rule.

status -> (string)

The status code for a URL rewrite or redirect rule.

200

Represents a 200 rewrite rule.

301

Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

302

Represents a 302 temporary redirect rule.

404

Represents a 404 redirect rule.

404-200

Represents a 404 rewrite rule.

condition -> (string)

The condition for a URL rewrite or redirect rule, such as a country code.

productionBranch -> (structure)

Describes the information about a production branch of the Amplify app.

lastDeployTime -> (timestamp)

The last deploy time of the production branch.

status -> (string)

The status of the production branch.

thumbnailUrl -> (string)

The thumbnail URL for the production branch.

branchName -> (string)

The branch name for the production branch.

buildSpec -> (string)

Describes the content of the build specification (build spec) for the Amplify app.

enableAutoBranchCreation -> (boolean)

Enables automated branch creation for the Amplify app.

autoBranchCreationPatterns -> (list)

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

(string)

autoBranchCreationConfig -> (structure)

Describes the automated branch creation configuration for the Amplify app.

stage -> (string)

Describes the current stage for the autocreated branch.

framework -> (string)

The framework for the autocreated branch.

enableAutoBuild -> (boolean)

Enables auto building for the autocreated branch.

environmentVariables -> (map)

The environment variables for the autocreated branch.

key -> (string)

value -> (string)

basicAuthCredentials -> (string)

The basic authorization credentials for the autocreated branch.

enableBasicAuth -> (boolean)

Enables basic authorization for the autocreated branch.

enablePerformanceMode -> (boolean)

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

buildSpec -> (string)

The build specification (build spec) for the autocreated branch.

enablePullRequestPreview -> (boolean)

Enables pull request preview for the autocreated branch.

pullRequestEnvironmentName -> (string)

The Amplify environment name for the pull request.