AWS::Amplify::App AutoBranchCreationConfig

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AutoBranchCreationPatterns" : [ String, ... ],
  "BasicAuthConfig" : BasicAuthConfig,
  "BuildSpec" : String,
  "EnableAutoBranchCreation" : Boolean,
  "EnableAutoBuild" : Boolean,
  "EnablePerformanceMode" : Boolean,
  "EnablePullRequestPreview" : Boolean,
  "EnvironmentVariables" : [ EnvironmentVariable, ... ],
  "Framework" : String,
  "PullRequestEnvironmentName" : String,
  "Stage" : String
}

YAML

  AutoBranchCreationPatterns: 
    - String
  BasicAuthConfig: 
    BasicAuthConfig
  BuildSpec: String
  EnableAutoBranchCreation: Boolean
  EnableAutoBuild: Boolean
  EnablePerformanceMode: Boolean
  EnablePullRequestPreview: Boolean
  EnvironmentVariables: 
    - EnvironmentVariable
  Framework: String
  PullRequestEnvironmentName: String
  Stage: String

Properties

AutoBranchCreationPatterns

Automated branch creation glob patterns for the Amplify app.

Required: No

Type: Array of String

Minimum: 1

Maximum: 2048

Update requires: No interruption

BasicAuthConfig

Sets password protection for your auto created branch.

Required: No

Type: BasicAuthConfig

Update requires: No interruption

BuildSpec

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

Required: No

Type: String

Minimum: 1

Maximum: 25000

Update requires: No interruption

EnableAutoBranchCreation

Enables automated branch creation for the Amplify app.

Required: No

Type: Boolean

Update requires: No interruption

EnableAutoBuild

Enables auto building for the auto created branch.

Required: No

Type: Boolean

Update requires: No interruption

EnablePerformanceMode

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.

Required: No

Type: Boolean

Update requires: No interruption

EnablePullRequestPreview

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.

Required: No

Type: Boolean

Update requires: No interruption

EnvironmentVariables

The environment variables for the autocreated branch.

Required: No

Type: Array of EnvironmentVariable

Update requires: No interruption

Framework

The framework for the autocreated branch.

Required: No

Type: String

Pattern: (?s).*

Maximum: 255

Update requires: No interruption

PullRequestEnvironmentName

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.

Required: No

Type: String

Pattern: (?s).*

Maximum: 20

Update requires: No interruption

Stage

Stage for the auto created branch.

Required: No

Type: String

Allowed values: EXPERIMENTAL | BETA | PULL_REQUEST | PRODUCTION | DEVELOPMENT

Update requires: No interruption