Branch

The branch for an Amplify app, which maps to a third-party repository branch.

activeJobId

The ID of the active job for a branch of an Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

branchArn

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: Yes

branchName

The name for the branch that is part of an Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: Yes

createTime

The creation date and time for a branch that is part of an Amplify app.

Type: Timestamp

Required: Yes

customDomains

The custom domains for a branch of an Amplify app.

Type: Array of strings

Array Members: Maximum number of 255 items.

Length Constraints: Maximum length of 255.

Required: Yes

description

The description for the branch that is part of an Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: Yes

displayName

The display name for the branch. This is used as the default domain prefix.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: Yes

enableAutoBuild

Enables auto-building on push for a branch of an Amplify app.

Type: Boolean

Required: Yes

enableBasicAuth

Enables basic authorization for a branch of an Amplify app.

Type: Boolean

Required: Yes

enableNotification

Enables notifications for a branch that is part of an Amplify app.

Type: Boolean

Required: Yes

enablePullRequestPreview

Enables pull request previews for the branch.

Type: Boolean

Required: Yes

environmentVariables

The environment variables specific to a branch of an Amplify app.

Type: String to string map

Key Length Constraints: Maximum length of 255.

Key Pattern: (?s).*

Value Length Constraints: Maximum length of 5500.

Value Pattern: (?s).*

Required: Yes

framework

The framework for a branch of an Amplify app.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: Yes

stage

The current stage for the branch that is part of an Amplify app.

Type: String

Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

Required: Yes

totalNumberOfJobs

The total number of jobs that are part of an Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

ttl

The content Time to Live (TTL) for the website in seconds.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32.

Pattern: \d*

Required: Yes

updateTime

The last updated date and time for a branch that is part of an Amplify app.

Type: Timestamp

Required: Yes

associatedResources

A list of custom resources that are linked to this branch.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

backend

Describes the backend associated with an Amplify Branch.

This property 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.

Type: Backend object

Required: No

backendEnvironmentArn

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: (?s).*

Required: No

basicAuthCredentials

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.

Type: String

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Required: No

buildSpec

The build specification (build spec) content for the branch of an Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

Required: No

destinationBranch

The destination branch if the branch is a pull request branch.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: No

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.

Type: Boolean

Required: No

pullRequestEnvironmentName

The Amplify environment name for the pull request.

Type: String

Length Constraints: Maximum length of 20.

Pattern: (?s).*

Required: No

sourceBranch

The source branch if the branch is a pull request branch.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: No

tags

The tag for the branch of an Amplify app.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

thumbnailUrl

The thumbnail URL for the branch of an Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

Branch

Contents

See Also