update-branch¶
Description¶
Updates a branch for an Amplify app.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-branch
--app-id <value>
--branch-name <value>
[--description <value>]
[--framework <value>]
[--stage <value>]
[--enable-notification | --no-enable-notification]
[--enable-auto-build | --no-enable-auto-build]
[--environment-variables <value>]
[--basic-auth-credentials <value>]
[--enable-basic-auth | --no-enable-basic-auth]
[--enable-performance-mode | --no-enable-performance-mode]
[--build-spec <value>]
[--ttl <value>]
[--display-name <value>]
[--enable-pull-request-preview | --no-enable-pull-request-preview]
[--pull-request-environment-name <value>]
[--backend-environment-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--app-id (string)
The unique ID for an Amplify app.
--branch-name (string)
The name for the branch.
--description (string)
The description for the branch.
--framework (string)
The framework for the branch.
--stage (string)
Describes the current stage for the branch.
Possible values:
PRODUCTION
BETA
DEVELOPMENT
EXPERIMENTAL
PULL_REQUEST
--enable-notification | --no-enable-notification (boolean)
Enables notifications for the branch.
--enable-auto-build | --no-enable-auto-build (boolean)
Enables auto building for the branch.
--environment-variables (map)
The environment variables for the branch.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--basic-auth-credentials (string)
The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format
user:password.
--enable-basic-auth | --no-enable-basic-auth (boolean)
Enables basic authorization for the branch.
--enable-performance-mode | --no-enable-performance-mode (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.
--build-spec (string)
The build specification (build spec) for the branch.
--ttl (string)
The content Time to Live (TTL) for the website in seconds.
--display-name (string)
The display name for a branch. This is used as the default domain prefix.
--enable-pull-request-preview | --no-enable-pull-request-preview (boolean)
Enables pull request previews for this branch.
--pull-request-environment-name (string)
The Amplify environment name for the pull request.
--backend-environment-arn (string)
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
branch -> (structure)
The branch for an Amplify app, which maps to a third-party repository branch.
branchArn -> (string)
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branchName -> (string)
The name for the branch that is part of an Amplify app.
description -> (string)
The description for the branch that is part of an Amplify app.
tags -> (map)
The tag for the branch of an Amplify app.
key -> (string)
value -> (string)
stage -> (string)
The current stage for the branch that is part of an Amplify app.
displayName -> (string)
The display name for the branch. This is used as the default domain prefix.
enableNotification -> (boolean)
Enables notifications for a branch that is part of an Amplify app.
createTime -> (timestamp)
The creation date and time for a branch that is part of an Amplify app.
updateTime -> (timestamp)
The last updated date and time for a branch that is part of an Amplify app.
environmentVariables -> (map)
The environment variables specific to a branch of an Amplify app.
key -> (string)
value -> (string)
enableAutoBuild -> (boolean)
Enables auto-building on push for a branch of an Amplify app.
customDomains -> (list)
The custom domains for a branch of an Amplify app.
(string)
framework -> (string)
The framework for a branch of an Amplify app.
activeJobId -> (string)
The ID of the active job for a branch of an Amplify app.
totalNumberOfJobs -> (string)
The total number of jobs that are part of an Amplify app.
enableBasicAuth -> (boolean)
Enables basic authorization for a branch of an Amplify app.
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.
thumbnailUrl -> (string)
The thumbnail URL for the branch of an Amplify app.
basicAuthCredentials -> (string)
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format
user:password.buildSpec -> (string)
The build specification (build spec) content for the branch of an Amplify app.
ttl -> (string)
The content Time to Live (TTL) for the website in seconds.
associatedResources -> (list)
A list of custom resources that are linked to this branch.
(string)
enablePullRequestPreview -> (boolean)
Enables pull request previews for the branch.
pullRequestEnvironmentName -> (string)
The Amplify environment name for the pull request.
destinationBranch -> (string)
The destination branch if the branch is a pull request branch.
sourceBranch -> (string)
The source branch if the branch is a pull request branch.
backendEnvironmentArn -> (string)
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.