1.204.0

interface CfnBranchProps

LanguageType name
.NETAmazon.CDK.AWS.Amplify.CfnBranchProps
Javasoftware.amazon.awscdk.services.amplify.CfnBranchProps
Pythonaws_cdk.aws_amplify.CfnBranchProps
TypeScript @aws-cdk/aws-amplify » CfnBranchProps

Properties for defining a CfnBranch.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify from '@aws-cdk/aws-amplify';
const cfnBranchProps: amplify.CfnBranchProps = {
  appId: 'appId',
  branchName: 'branchName',

  // the properties below are optional
  basicAuthConfig: {
    password: 'password',
    username: 'username',

    // the properties below are optional
    enableBasicAuth: false,
  },
  buildSpec: 'buildSpec',
  description: 'description',
  enableAutoBuild: false,
  enablePerformanceMode: false,
  enablePullRequestPreview: false,
  environmentVariables: [{
    name: 'name',
    value: 'value',
  }],
  framework: 'framework',
  pullRequestEnvironmentName: 'pullRequestEnvironmentName',
  stage: 'stage',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
appIdstringThe unique ID for an Amplify app.
branchNamestringThe name for the branch.
basicAuthConfig?IResolvable | BasicAuthConfigPropertyThe basic authorization credentials for a branch of an Amplify app.
buildSpec?stringThe build specification (build spec) for the branch.
description?stringThe description for the branch that is part of an Amplify app.
enableAutoBuild?boolean | IResolvableEnables auto building for the branch.
enablePerformanceMode?boolean | IResolvableEnables performance mode for the branch.
enablePullRequestPreview?boolean | IResolvableSpecifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
environmentVariables?IResolvable | IResolvable | EnvironmentVariableProperty[]The environment variables for the branch.
framework?stringThe framework for the branch.
pullRequestEnvironmentName?stringIf pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
stage?stringDescribes the current stage for the branch.
tags?CfnTag[]The tag for the branch.

appId

Type: string

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

branchName

Type: string

The name for the branch.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

basicAuthConfig?

Type: IResolvable | BasicAuthConfigProperty (optional)

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 .

buildSpec?

Type: string (optional)

The build specification (build spec) for the branch.

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

description?

Type: string (optional)

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

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

enableAutoBuild?

Type: boolean | IResolvable (optional)

Enables auto building for the branch.

enablePerformanceMode?

Type: boolean | IResolvable (optional)

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.

enablePullRequestPreview?

Type: boolean | IResolvable (optional)

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 in the AWS Amplify Hosting User Guide .

environmentVariables?

Type: IResolvable | IResolvable | EnvironmentVariableProperty[] (optional)

The environment variables for the branch.

framework?

Type: string (optional)

The framework for the branch.

pullRequestEnvironmentName?

Type: string (optional)

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 in the AWS Amplify Hosting User Guide .

Length Constraints: Maximum length of 20.

Pattern: (?s).*

stage?

Type: string (optional)

Describes the current stage for the branch.

Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

tags?

Type: CfnTag[] (optional)

The tag for the branch.

← PreviousNext →