UpdateBranchRequest

Gets and sets the property AppId.

The unique ID for an Amplify app.

Gets and sets the property Backend.

The backend for a Branch of an Amplify app. Use for a backend created from an 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.

Gets and sets the property BackendEnvironmentArn.

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

This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

Gets and sets the property BasicAuthCredentials.

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

Gets and sets the property BranchName.

The name of the branch.

Gets and sets the property BuildSpec.

The build specification (build spec) for the branch.

Gets and sets the property ComputeRoleArn.

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services 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.

Gets and sets the property Description.

The description for the branch.

Gets and sets the property DisplayName.

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

Gets and sets the property EnableAutoBuild.

Enables auto building for the branch.

Gets and sets the property EnableBasicAuth.

Enables basic authorization for the branch.

Gets and sets the property EnableNotification.

Enables notifications for the branch.

Gets and sets the property 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.

Gets and sets the property EnablePullRequestPreview.

Enables pull request previews for this branch.

Gets and sets the property EnvironmentVariables.

The environment variables for the branch.

Gets and sets the property Framework.

The framework for the branch.

Gets and sets the property PullRequestEnvironmentName.

The Amplify environment name for the pull request.

Gets and sets the property Stage.

Describes the current stage for the branch.

Gets and sets the property Ttl.

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