Branch

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

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

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

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

A timestamp of when Amplify created the branch.

Type: Timestamp

Required: Yes

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

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

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: Yes

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

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

Type: Boolean

Required: Yes

Enables basic authorization for a branch of an Amplify app.

Type: Boolean

Required: Yes

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

Type: Boolean

Required: Yes

Enables pull request previews for the branch.

Type: Boolean

Required: Yes

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

The framework for a branch of an Amplify app.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: Yes

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

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

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

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

A timestamp for the last updated time for a branch.

Type: Timestamp

Required: Yes

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

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

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

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

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

The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Type: String

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

Pattern: (?s).*

Required: No

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

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

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

Type: Boolean

Required: No

The Amplify environment name for the pull request.

Type: String

Length Constraints: Maximum length of 20.

Pattern: (?s).*

Required: No

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

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

The thumbnail URL for the branch of an Amplify app.

Type: String

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

Required: No