AWS::Amplify::Branch

The AWS::Amplify::Branch resource creates a new branch within an app.

Syntax

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

JSON

{
  "Type" : "AWS::Amplify::Branch",
  "Properties" : {
      "AppId" : String,
      "BasicAuthConfig" : BasicAuthConfig,
      "BranchName" : String,
      "BuildSpec" : String,
      "Description" : String,
      "EnableAutoBuild" : Boolean,
      "EnablePerformanceMode" : Boolean,
      "EnablePullRequestPreview" : Boolean,
      "EnvironmentVariables" : [ EnvironmentVariable, ... ],
      "PullRequestEnvironmentName" : String,
      "Stage" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Amplify::Branch
Properties: 
  AppId: String
  BasicAuthConfig: 
    BasicAuthConfig
  BranchName: String
  BuildSpec: String
  Description: String
  EnableAutoBuild: Boolean
  EnablePerformanceMode: Boolean
  EnablePullRequestPreview: Boolean
  EnvironmentVariables: 
    - EnvironmentVariable
  PullRequestEnvironmentName: String
  Stage: String
  Tags: 
    - Tag

Properties

AppId

The unique ID for an Amplify app.

Required: Yes

Type: String

Update requires: Replacement

BasicAuthConfig

The basic authorization credentials for a branch of an Amplify app.

Required: No

Type: BasicAuthConfig

Update requires: No interruption

BranchName

The name for the branch.

Required: Yes

Type: String

Update requires: Replacement

BuildSpec

The build specification (build spec) for the branch.

Required: No

Type: String

Update requires: No interruption

Description

The description for the branch.

Required: No

Type: String

Update requires: No interruption

EnableAutoBuild

Enables auto building for the 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 the Amplify Console creates a preview for each pull request that is made for this branch. If this property is enabled, the Amplify Console 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, the Amplify Console 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 Console User Guide.

Required: No

Type: Boolean

Update requires: No interruption

EnvironmentVariables

The environment variables for the branch.

Required: No

Type: List of EnvironmentVariable

Update requires: No interruption

PullRequestEnvironmentName

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, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console 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 Console User Guide.

Required: No

Type: String

Update requires: No interruption

Stage

Describes the current stage for the branch.

Required: No

Type: String

Update requires: No interruption

Tags

The tag for the branch.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Fn::GetAtt

Arn

ARN for a branch, part of an Amplify App.

BranchName

Name for a branch, part of an Amplify App.