L1 ConstructAWS::Amplify::Branch

CfnBranch

The AWS::Amplify::Branch resource specifies a new branch within an app.

Import

import { CfnBranch } from 'aws-cdk-lib/aws-amplify';

Or use the module namespace:

import * as amplify from 'aws-cdk-lib/aws-amplify';
// amplify.CfnBranch

Properties

Configuration passed to the constructor as CfnBranchProps.

appIdRequired

string

The unique ID for an Amplify app.

branchNameRequired

string

The name for the branch.

backendOptional

IResolvable | BackendProperty

The backend for a `Branch` of an Amplify app. Use for a backend created from an CloudFormation stack. This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basicAuthConfigOptional

IResolvable | BasicAuthConfigProperty

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

buildSpecOptional

string

The build specification (build spec) for the branch.

computeRoleArnOptional

string

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see [Adding an SSR Compute role](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html) in the *Amplify User Guide* .

descriptionOptional

string

The description for the branch that is part of an Amplify app.

enableAutoBuildOptional

boolean | IResolvable

Enables auto building for the branch.

enablePerformanceModeOptional

boolean | IResolvable

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.

enablePullRequestPreviewOptional

boolean | IResolvable

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property. For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .

enableSkewProtectionOptional

boolean | IResolvable

Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see [Skew protection for Amplify deployments](https://docs.aws.amazon.com/amplify/latest/userguide/skew-protection.html) in the *Amplify User Guide* .

environmentVariablesOptional

IResolvable | IResolvable | EnvironmentVariableProperty[]

The environment variables for the branch.

frameworkOptional

string

The framework for the branch.

pullRequestEnvironmentNameOptional

string

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch. To enable pull request previews, set the `EnablePullRequestPreview` property to `true` . If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed. For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .

stageOptional

string

Describes the current stage for the branch.

tagsOptional

CfnTag[]

The tag for the branch.