Table Of Contents

Feedback

User Guide

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

[ aws . amplify ]

create-branch

Description

Creates a new Branch for an Amplify App.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-branch
--app-id <value>
--branch-name <value>
[--description <value>]
[--stage <value>]
[--framework <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]
[--tags <value>]
[--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 <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an Amplify App.

--branch-name (string)

Name for the branch.

--description (string)

Description for the branch.

--stage (string)

Stage for the branch.

Possible values:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

--framework (string)

Framework for the branch.

--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)

Environment Variables for the branch.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--basic-auth-credentials (string)

Basic Authorization credentials for the branch.

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

Enables Basic Auth for the branch.

--tags (map)

Tag for the branch.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--build-spec (string)

BuildSpec for the branch.

--ttl (string)

The content TTL for the website in seconds.

--display-name (string)

Display name for a branch, will use as the default domain prefix.

--enable-pull-request-preview | --no-enable-pull-request-preview (boolean)

Enables Pull Request Preview for this branch.

--pull-request-environment-name (string)

The Amplify Environment name for the pull request.

--backend-environment-arn (string)

ARN for a Backend Environment, part of an Amplify App.

--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

branch -> (structure)

Branch structure for an Amplify App.

branchArn -> (string)

ARN for a branch, part of an Amplify App.

branchName -> (string)

Name for a branch, part of an Amplify App.

description -> (string)

Description for a branch, part of an Amplify App.

tags -> (map)

Tag for branch for Amplify App.

key -> (string)

value -> (string)

stage -> (string)

Stage for a branch, part of an Amplify App.

displayName -> (string)

Display name for a branch, will use as the default domain prefix.

enableNotification -> (boolean)

Enables notifications for a branch, part of an Amplify App.

createTime -> (timestamp)

Creation date and time for a branch, part of an Amplify App.

updateTime -> (timestamp)

Last updated date and time for a branch, part of an Amplify App.

environmentVariables -> (map)

Environment Variables specific to a branch, part of an Amplify App.

key -> (string)

value -> (string)

enableAutoBuild -> (boolean)

Enables auto-building on push for a branch, part of an Amplify App.

customDomains -> (list)

Custom domains for a branch, part of an Amplify App.

(string)

framework -> (string)

Framework for a branch, part of an Amplify App.

activeJobId -> (string)

Id of the active job for a branch, part of an Amplify App.

totalNumberOfJobs -> (string)

Total number of Jobs part of an Amplify App.

enableBasicAuth -> (boolean)

Enables Basic Authorization for a branch, part of an Amplify App.

thumbnailUrl -> (string)

Thumbnail URL for the branch.

basicAuthCredentials -> (string)

Basic Authorization credentials for a branch, part of an Amplify App.

buildSpec -> (string)

BuildSpec content for branch for Amplify App.

ttl -> (string)

The content TTL for the website in seconds.

associatedResources -> (list)

List of custom resources that are linked to this branch.

(string)

enablePullRequestPreview -> (boolean)

Enables Pull Request Preview for this 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)

ARN for a Backend Environment, part of an Amplify App.