Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amplify
  5. Branch

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.amplify.Branch

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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

Create Branch Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Branch(name: string, args: BranchArgs, opts?: CustomResourceOptions);
@overload
def Branch(resource_name: str,
           args: BranchArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Branch(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           app_id: Optional[str] = None,
           backend: Optional[BranchBackendArgs] = None,
           basic_auth_config: Optional[BranchBasicAuthConfigArgs] = None,
           branch_name: Optional[str] = None,
           build_spec: Optional[str] = None,
           description: Optional[str] = None,
           enable_auto_build: Optional[bool] = None,
           enable_performance_mode: Optional[bool] = None,
           enable_pull_request_preview: Optional[bool] = None,
           environment_variables: Optional[Sequence[BranchEnvironmentVariableArgs]] = None,
           framework: Optional[str] = None,
           pull_request_environment_name: Optional[str] = None,
           stage: Optional[BranchStage] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewBranch(ctx *Context, name string, args BranchArgs, opts ...ResourceOption) (*Branch, error)
public Branch(string name, BranchArgs args, CustomResourceOptions? opts = null)
public Branch(String name, BranchArgs args)
public Branch(String name, BranchArgs args, CustomResourceOptions options)

type: aws-native:amplify:Branch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BranchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BranchArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BranchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BranchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BranchArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Branch Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Branch resource accepts the following input properties:

AppId This property is required. string
The unique ID for an Amplify app.
Backend Pulumi.AwsNative.Amplify.Inputs.BranchBackend

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

BasicAuthConfig Pulumi.AwsNative.Amplify.Inputs.BranchBasicAuthConfig
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
BranchName string
The name for the branch.
BuildSpec string
The build specification (build spec) for the branch.
Description string
The description for the branch that is part of an Amplify app.
EnableAutoBuild bool
Enables auto building for the branch.
EnablePerformanceMode bool

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 bool

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 List<Pulumi.AwsNative.Amplify.Inputs.BranchEnvironmentVariable>
The environment variables for the branch.
Framework string
The framework for the branch.
PullRequestEnvironmentName string

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 Pulumi.AwsNative.Amplify.BranchStage
Describes the current stage for the branch.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The tag for the branch.
AppId This property is required. string
The unique ID for an Amplify app.
Backend BranchBackendArgs

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

BasicAuthConfig BranchBasicAuthConfigArgs
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
BranchName string
The name for the branch.
BuildSpec string
The build specification (build spec) for the branch.
Description string
The description for the branch that is part of an Amplify app.
EnableAutoBuild bool
Enables auto building for the branch.
EnablePerformanceMode bool

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 bool

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 []BranchEnvironmentVariableArgs
The environment variables for the branch.
Framework string
The framework for the branch.
PullRequestEnvironmentName string

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 BranchStage
Describes the current stage for the branch.
Tags TagArgs
The tag for the branch.
appId This property is required. String
The unique ID for an Amplify app.
backend BranchBackend

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basicAuthConfig BranchBasicAuthConfig
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
branchName String
The name for the branch.
buildSpec String
The build specification (build spec) for the branch.
description String
The description for the branch that is part of an Amplify app.
enableAutoBuild Boolean
Enables auto building for the branch.
enablePerformanceMode Boolean

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 Boolean

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 List<BranchEnvironmentVariable>
The environment variables for the branch.
framework String
The framework for the branch.
pullRequestEnvironmentName String

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 BranchStage
Describes the current stage for the branch.
tags List<Tag>
The tag for the branch.
appId This property is required. string
The unique ID for an Amplify app.
backend BranchBackend

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basicAuthConfig BranchBasicAuthConfig
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
branchName string
The name for the branch.
buildSpec string
The build specification (build spec) for the branch.
description string
The description for the branch that is part of an Amplify app.
enableAutoBuild boolean
Enables auto building for the branch.
enablePerformanceMode boolean

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 boolean

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 BranchEnvironmentVariable[]
The environment variables for the branch.
framework string
The framework for the branch.
pullRequestEnvironmentName string

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 BranchStage
Describes the current stage for the branch.
tags Tag[]
The tag for the branch.
app_id This property is required. str
The unique ID for an Amplify app.
backend BranchBackendArgs

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basic_auth_config BranchBasicAuthConfigArgs
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
branch_name str
The name for the branch.
build_spec str
The build specification (build spec) for the branch.
description str
The description for the branch that is part of an Amplify app.
enable_auto_build bool
Enables auto building for the branch.
enable_performance_mode bool

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.

enable_pull_request_preview bool

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 .

environment_variables Sequence[BranchEnvironmentVariableArgs]
The environment variables for the branch.
framework str
The framework for the branch.
pull_request_environment_name str

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 BranchStage
Describes the current stage for the branch.
tags Sequence[TagArgs]
The tag for the branch.
appId This property is required. String
The unique ID for an Amplify app.
backend Property Map

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

basicAuthConfig Property Map
The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password .
branchName String
The name for the branch.
buildSpec String
The build specification (build spec) for the branch.
description String
The description for the branch that is part of an Amplify app.
enableAutoBuild Boolean
Enables auto building for the branch.
enablePerformanceMode Boolean

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 Boolean

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify 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, Amplify 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 List<Property Map>
The environment variables for the branch.
framework String
The framework for the branch.
pullRequestEnvironmentName String

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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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 "EXPERIMENTAL" | "BETA" | "PULL_REQUEST" | "PRODUCTION" | "DEVELOPMENT"
Describes the current stage for the branch.
tags List<Property Map>
The tag for the branch.

Outputs

All input properties are implicitly available as output properties. Additionally, the Branch resource produces the following output properties:

Arn string
ARN for a branch, part of an Amplify App.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
ARN for a branch, part of an Amplify App.
Id string
The provider-assigned unique ID for this managed resource.
arn String
ARN for a branch, part of an Amplify App.
id String
The provider-assigned unique ID for this managed resource.
arn string
ARN for a branch, part of an Amplify App.
id string
The provider-assigned unique ID for this managed resource.
arn str
ARN for a branch, part of an Amplify App.
id str
The provider-assigned unique ID for this managed resource.
arn String
ARN for a branch, part of an Amplify App.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

BranchBackend
, BranchBackendArgs

StackArn string
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
StackArn string
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
stackArn String
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
stackArn string
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
stack_arn str
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
stackArn String
The Amazon Resource Name (ARN) for the AWS CloudFormation stack.

BranchBasicAuthConfig
, BranchBasicAuthConfigArgs

Password This property is required. string
The password for basic authorization.
Username This property is required. string
EnableBasicAuth bool
Enables basic authorization for the branch.
Password This property is required. string
The password for basic authorization.
Username This property is required. string
EnableBasicAuth bool
Enables basic authorization for the branch.
password This property is required. String
The password for basic authorization.
username This property is required. String
enableBasicAuth Boolean
Enables basic authorization for the branch.
password This property is required. string
The password for basic authorization.
username This property is required. string
enableBasicAuth boolean
Enables basic authorization for the branch.
password This property is required. str
The password for basic authorization.
username This property is required. str
enable_basic_auth bool
Enables basic authorization for the branch.
password This property is required. String
The password for basic authorization.
username This property is required. String
enableBasicAuth Boolean
Enables basic authorization for the branch.

BranchEnvironmentVariable
, BranchEnvironmentVariableArgs

Name This property is required. string
The environment variable name.
Value This property is required. string
The environment variable value.
Name This property is required. string
The environment variable name.
Value This property is required. string
The environment variable value.
name This property is required. String
The environment variable name.
value This property is required. String
The environment variable value.
name This property is required. string
The environment variable name.
value This property is required. string
The environment variable value.
name This property is required. str
The environment variable name.
value This property is required. str
The environment variable value.
name This property is required. String
The environment variable name.
value This property is required. String
The environment variable value.

BranchStage
, BranchStageArgs

Experimental
EXPERIMENTAL
Beta
BETA
PullRequest
PULL_REQUEST
Production
PRODUCTION
Development
DEVELOPMENT
BranchStageExperimental
EXPERIMENTAL
BranchStageBeta
BETA
BranchStagePullRequest
PULL_REQUEST
BranchStageProduction
PRODUCTION
BranchStageDevelopment
DEVELOPMENT
Experimental
EXPERIMENTAL
Beta
BETA
PullRequest
PULL_REQUEST
Production
PRODUCTION
Development
DEVELOPMENT
Experimental
EXPERIMENTAL
Beta
BETA
PullRequest
PULL_REQUEST
Production
PRODUCTION
Development
DEVELOPMENT
EXPERIMENTAL
EXPERIMENTAL
BETA
BETA
PULL_REQUEST
PULL_REQUEST
PRODUCTION
PRODUCTION
DEVELOPMENT
DEVELOPMENT
"EXPERIMENTAL"
EXPERIMENTAL
"BETA"
BETA
"PULL_REQUEST"
PULL_REQUEST
"PRODUCTION"
PRODUCTION
"DEVELOPMENT"
DEVELOPMENT

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native