> **Experimental**
>
> `@aws-cdk/aws-amplify-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# Branch

An Amplify Console branch.

Extends: Construct › Resource › Branch
Implements: IBranch, IResource, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/branch.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-amplify-alpha/lib/branch.ts#L168)

## Example

```ts
declare const computeRole: iam.Role;
declare const amplifyApp: amplify.App

const branch = amplifyApp.addBranch("dev", { computeRole });
```

## Initializer

```ts
new Branch(scope: Construct, id: string, props: BranchProps)
```

## Construct Props

- `app`: [IApp](/cdk/api/v2/docs/@aws-cdk_aws-amplify-alpha.IApp.html) (required) — The application within which the branch must be created.

- `asset`: [Asset](/cdk/api/v2/docs/aws-cdk-lib.aws_s3_assets.Asset.html) — Asset for deployment.

  **Default:** no asset

  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`: boolean = true — Whether to enable auto building for the branch.

- `basicAuth`: [BasicAuth](/cdk/api/v2/docs/@aws-cdk_aws-amplify-alpha.BasicAuth.html) — The Basic Auth configuration.

  **Default:** no password protection

  Use this to set password protection for
  the branch

- `branchName`: string — The name of the branch.

  **Default:** the construct's id

- `buildSpec`: [BuildSpec](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.BuildSpec.html) — BuildSpec for the branch.

  **Default:** no build spec

- `computeRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The IAM role to assign to a branch of an SSR app.

  **Default:** undefined - No specific role for the branch. If the app has a compute role, it will be inherited.

  The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions.

  This role overrides the app-level compute role.

- `description`: string — A description for the branch.

  **Default:** no description

- `environmentVariables`: { [key: string]: string } — Environment variables for the branch.

  **Default:** application environment variables

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

- `performanceMode`: boolean = 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`: string — The dedicated backend environment for the pull request previews.

  **Default:** automatically provision a temporary backend

- `pullRequestPreview`: boolean = true — Whether to enable pull request preview for the branch.

- `skewProtection`: boolean — Specifies whether the skew protection feature is enabled for the branch.

  **Default:** None - Default setting is no skew protection.

  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.

- `stage`: string — Stage for the branch.

  **Default:** no stage

## Properties

- `arn`: string — The ARN of the branch.

- `branchName`: string — The name of the branch.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addEnvironment(name: string, value: string): Branch // chainable` — Adds an environment variable to this branch.

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

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromBranchName(scope: Construct, id: string, branchName: string): IBranch` (static) — Import an existing branch.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.