• Public
  • Public/Protected
  • All

Interface CreateBranchCommandInput





appId: string | undefined

The unique ID for an Amplify app.

Optional backendEnvironmentArn

backendEnvironmentArn: undefined | string

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

Optional basicAuthCredentials

basicAuthCredentials: undefined | string

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


branchName: string | undefined

The name for the branch.

Optional buildSpec

buildSpec: undefined | string

The build specification (build spec) for the branch.

Optional description

description: undefined | string

The description for the branch.

Optional displayName

displayName: undefined | string

The display name for a branch. This is used as the default domain prefix.

Optional enableAutoBuild

enableAutoBuild: undefined | false | true

Enables auto building for the branch.

Optional enableBasicAuth

enableBasicAuth: undefined | false | true

Enables basic authorization for the branch.

Optional enableNotification

enableNotification: undefined | false | true

Enables notifications for the branch.

Optional enablePerformanceMode

enablePerformanceMode: undefined | false | true

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.

Optional enablePullRequestPreview

enablePullRequestPreview: undefined | false | true

Enables pull request previews for this branch.

Optional environmentVariables

environmentVariables: Record<string, string>

The environment variables for the branch.

Optional framework

framework: undefined | string

The framework for the branch.

Optional pullRequestEnvironmentName

pullRequestEnvironmentName: undefined | string

The Amplify environment name for the pull request.

Optional stage

stage: Stage | string

Describes the current stage for the branch.

Optional tags

tags: Record<string, string>

The tag for the branch.

Optional ttl

ttl: undefined | string

The content Time To Live (TTL) for the website in seconds.