Amplify Branch

Docs > DDSQL Reference > Data Directory > Amplify Branch

An Amplify Branch in AWS represents a deployment branch within an Amplify App. It allows you to connect a specific Git branch to your Amplify environment, enabling continuous deployment of front-end web applications. Each branch can have its own build settings, environment variables, and custom domains, making it easy to manage multiple environments such as development, staging, and production.

aws.amplify_branch

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
active_job_id	core	string	The ID of the active job for a branch of an Amplify app.
associated_resources	core	array<string>	A list of custom resources that are linked to this branch.
backend	core	json	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.
backend_environment_arn	core	string	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.
basic_auth_credentials	core	string	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_arn	core	string	The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
branch_name	core	string	The name for the branch that is part of an Amplify app.
build_spec	core	string	The build specification (build spec) content for the branch of an Amplify app.
compute_role_arn	core	string	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 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.
create_time	core	timestamp	A timestamp of when Amplify created the branch.
custom_domains	core	array<string>	The custom domains for a branch of an Amplify app.
description	core	string	The description for the branch that is part of an Amplify app.
destination_branch	core	string	The destination branch if the branch is a pull request branch.
enable_auto_build	core	bool	Enables auto-building on push for a branch of an Amplify app.
enable_basic_auth	core	bool	Enables basic authorization for a branch of an Amplify app.
enable_notification	core	bool	Enables notifications for a branch that is part of an Amplify app.
enable_performance_mode	core	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	core	bool	Enables pull request previews for the branch.
environment_variables	core	hstore	The environment variables specific to a branch of an Amplify app.
framework	core	string	The framework for a branch of an Amplify app.
pull_request_environment_name	core	string	The Amplify environment name for the pull request.
source_branch	core	string	The source branch if the branch is a pull request branch.
stage	core	string	The current stage for the branch that is part of an Amplify app.
tags	core	hstore
thumbnail_url	core	string	The thumbnail URL for the branch of an Amplify app.
total_number_of_jobs	core	string	The total number of jobs that are part of an Amplify app.
ttl	core	string	The content Time to Live (TTL) for the website in seconds.
update_time	core	timestamp	A timestamp for the last updated time for a branch.