Sign In to the Console
AWS CloudFormation
User Guide (Version )

AWS Documentation » AWS CloudFormation » User Guide » Amplify Console Resource Type Reference » AWS::Amplify::Branch

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,
      "EnvironmentVariables" : [ EnvironmentVariable, ... ],
      "Stage" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

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

Properties

AppId

Unique Id for an Amplify App.

Required: Yes

Type: String

Update requires: Replacement

BasicAuthConfig

Basic Authorization credentials for a branch, part of an Amplify App.

Required: No

Type: BasicAuthConfig

Update requires: No interruption

BranchName

Name for the branch.

Required: Yes

Type: String

Update requires: Replacement

BuildSpec

BuildSpec for the branch.

Required: No

Type: String

Update requires: No interruption

Description

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

EnvironmentVariables

Environment Variables for the branch.

Required: No

Type: List of EnvironmentVariable

Update requires: No interruption

Stage

Stage for the branch.

Required: No

Type: String

Update requires: No interruption

Tags

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.