interface AutoBranchCreationConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Amplify.CfnApp.AutoBranchCreationConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnApp_AutoBranchCreationConfigProperty`
Java	`software.amazon.awscdk.services.amplify.CfnApp.AutoBranchCreationConfigProperty`
Python	`aws_cdk.aws_amplify.CfnApp.AutoBranchCreationConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_amplify` » `CfnApp` » `AutoBranchCreationConfigProperty`

Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const autoBranchCreationConfigProperty: amplify.CfnApp.AutoBranchCreationConfigProperty = {
  autoBranchCreationPatterns: ['autoBranchCreationPatterns'],
  basicAuthConfig: {
    enableBasicAuth: false,
    password: 'password',
    username: 'username',
  },
  buildSpec: 'buildSpec',
  enableAutoBranchCreation: false,
  enableAutoBuild: false,
  enablePerformanceMode: false,
  enablePullRequestPreview: false,
  environmentVariables: [{
    name: 'name',
    value: 'value',
  }],
  framework: 'framework',
  pullRequestEnvironmentName: 'pullRequestEnvironmentName',
  stage: 'stage',
};

Properties

Name	Type	Description
autoBranchCreationPatterns?	`string[]`	Automated branch creation glob patterns for the Amplify app.
basicAuthConfig?	`IResolvable` `\|` `BasicAuthConfigProperty`	Sets password protection for your auto created branch.
buildSpec?	`string`	The build specification (build spec) for the autocreated branch.
enableAutoBranchCreation?	`boolean \|` `IResolvable`	Enables automated branch creation for the Amplify app.
enableAutoBuild?	`boolean \|` `IResolvable`	Enables auto building for the auto created branch.
enablePerformanceMode?	`boolean \|` `IResolvable`	Enables performance mode for the branch.
enablePullRequestPreview?	`boolean \|` `IResolvable`	Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app.
environmentVariables?	`IResolvable` `\|` `IResolvable` `\|` `EnvironmentVariableProperty[]`	The environment variables for the autocreated branch.
framework?	`string`	The framework for the autocreated branch.
pullRequestEnvironmentName?	`string`	If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews.
stage?	`string`	Stage for the auto created branch.

autoBranchCreationPatterns?

Type: string[] (optional)

Automated branch creation glob patterns for the Amplify app.

basicAuthConfig?

Type: IResolvable | BasicAuthConfigProperty (optional)

Sets password protection for your auto created branch.

buildSpec?

Type: string (optional)

The build specification (build spec) for the autocreated branch.

enableAutoBranchCreation?

Type: boolean | IResolvable (optional)

Enables automated branch creation for the Amplify app.

enableAutoBuild?

Type: boolean | IResolvable (optional)

Enables auto building for the auto created 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)

Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app.

Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. 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 Hosting 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 autocreated branch.

framework?

Type: string (optional)

The framework for the autocreated branch.

pullRequestEnvironmentName?

Type: string (optional)

If pull request previews are enabled, 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.

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

stage?

Type: string (optional)

Stage for the auto created branch.