AWS Fundamentals Logo
AWS Fundamentals
AWS::Amplify::Branch

Amplify Branch

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

Properties

16 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
AppId
string
RequiredCreate-only
BranchName
string
RequiredCreate-only
Backend
Backend
BasicAuthConfig
BasicAuthConfig
Write-only
BuildSpec
string
ComputeRoleArn
string
Description
string
EnableAutoBuild
boolean
EnablePerformanceMode
boolean
EnablePullRequestPreview
boolean
EnableSkewProtection
boolean
EnvironmentVariables
Array<EnvironmentVariable>
Framework
string
PullRequestEnvironmentName
string
Stage
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Amplify::Branch

Resources:
  MyResource:
    Type: AWS::Amplify::Branch
    Properties:
      AppId: "my-appid"
      BranchName: "my-branchname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

amplify:GetBranchamplify:CreateBranchamplify:TagResourcecodecommit:GetRepositorycodecommit:PutRepositoryTriggerscodecommit:GetRepositoryTriggerss3:GetObjects3:GetObjectAcl

delete

amplify:GetBranchamplify:DeleteBranchcodecommit:GetRepositorycodecommit:GetRepositoryTriggerssns:Unsubscribeiam:PassRole

list

amplify:GetBranchamplify:ListBranchesamplify:ListTagsForResourceiam:PassRole

read

amplify:GetBranchamplify:ListTagsForResourcecodecommit:GetRepositorycodecommit:GetRepositoryTriggerss3:GetObjects3:GetObjectAcliam:PassRole

update

amplify:GetBranchamplify:UpdateBranchamplify:ListTagsForResourceamplify:TagResourceamplify:UntagResourcecodecommit:GetRepositorycodecommit:PutRepositoryTriggerscodecommit:GetRepositoryTriggers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceAmplify
Properties17
Required2
TaggingSupported
Primary IDArn

Supported Operations

CreateDeleteListReadUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AppIdBranchName

Related Resources

External Links