interface BranchOptions 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Amplify.Alpha.BranchOptions
Go	github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#BranchOptions
Java	software.amazon.awscdk.services.amplify.alpha.BranchOptions
Python	aws_cdk.aws_amplify_alpha.BranchOptions
TypeScript (source)	@aws-cdk/aws-amplify-alpha » BranchOptions

Options to add a branch to an application.

Example

declare const amplifyApp: amplify.App;

const main = amplifyApp.addBranch('main'); // `id` will be used as repo branch name
const dev = amplifyApp.addBranch('dev', {
  performanceMode: true, // optional, enables performance mode
});
dev.addEnvironment('STAGE', 'dev');

Properties

Name	Type	Description
asset?🔹	Asset	Asset for deployment.
autoBuild?🔹	boolean	Whether to enable auto building for the branch.
basicAuth?🔹	BasicAuth	The Basic Auth configuration.
branchName?🔹	string	The name of the branch.
buildSpec?🔹	BuildSpec	BuildSpec for the branch.
description?🔹	string	A description for the branch.
environmentVariables?🔹	{ [string]: string }	Environment variables for the branch.
performanceMode?🔹	boolean	Enables performance mode for the branch.
pullRequestEnvironmentName?🔹	string	The dedicated backend environment for the pull request previews.
pullRequestPreview?🔹	boolean	Whether to enable pull request preview for the branch.
stage?🔹	string	Stage for the branch.

---

asset?🔹

Type: Asset (optional, default: no asset)

Asset for deployment.

The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's startDeployment API to initiate and deploy a S3 asset onto the App.

---

autoBuild?🔹

Type: boolean (optional, default: true)

Whether to enable auto building for the branch.

---

basicAuth?🔹

Type: BasicAuth (optional, default: no password protection)

The Basic Auth configuration.

Use this to set password protection for the branch

---

branchName?🔹

Type: string (optional, default: the construct's id)

The name of the branch.

---

buildSpec?🔹

Type: BuildSpec (optional, default: no build spec)

BuildSpec for the branch.

See also: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

---

description?🔹

Type: string (optional, default: no description)

A description for the branch.

---

environmentVariables?🔹

Type: { [string]: string } (optional, default: application environment variables)

Environment variables for the branch.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

---

performanceMode?🔹

Type: boolean (optional, default: false)

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.

---

pullRequestEnvironmentName?🔹

Type: string (optional, default: automatically provision a temporary backend)

The dedicated backend environment for the pull request previews.

---

pullRequestPreview?🔹

Type: boolean (optional, default: true)

Whether to enable pull request preview for the branch.

---

stage?🔹

Type: string (optional, default: no stage)

Stage for the branch.