interface BranchProps 🔹

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

Properties for a Branch.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import { aws_s3_assets as s3_assets } from 'aws-cdk-lib';

declare const app: amplify_alpha.App;
declare const asset: s3_assets.Asset;
declare const basicAuth: amplify_alpha.BasicAuth;
declare const buildSpec: codebuild.BuildSpec;
const branchProps: amplify_alpha.BranchProps = {
  app: app,

  // the properties below are optional
  asset: asset,
  autoBuild: false,
  basicAuth: basicAuth,
  branchName: 'branchName',
  buildSpec: buildSpec,
  description: 'description',
  environmentVariables: {
    environmentVariablesKey: 'environmentVariables',
  },
  performanceMode: false,
  pullRequestEnvironmentName: 'pullRequestEnvironmentName',
  pullRequestPreview: false,
  stage: 'stage',
};

Properties

Name	Type	Description
app🔹	`IApp`	The application within which the branch must be created.
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.

app🔹

Type: IApp

The application within which the branch must be created.

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.

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.