Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Branch

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

Hierarchy

  • Branch

Index

Properties

activeJobId

activeJobId: string | undefined

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

Optional associatedResources

associatedResources: string[]

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

Optional backendEnvironmentArn

backendEnvironmentArn: undefined | string

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

Optional basicAuthCredentials

basicAuthCredentials: undefined | 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.

branchArn

branchArn: string | undefined

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

branchName

branchName: string | undefined

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

Optional buildSpec

buildSpec: undefined | string

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

createTime

createTime: Date | undefined

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

customDomains

customDomains: string[] | undefined

The custom domains for a branch of an Amplify app.

description

description: string | undefined

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

Optional destinationBranch

destinationBranch: undefined | string

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

displayName

displayName: string | undefined

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

enableAutoBuild

enableAutoBuild: boolean | undefined

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

enableBasicAuth

enableBasicAuth: boolean | undefined

Enables basic authorization for a branch of an Amplify app.

enableNotification

enableNotification: boolean | undefined

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

Optional enablePerformanceMode

enablePerformanceMode: undefined | false | true

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

enablePullRequestPreview: boolean | undefined

Enables pull request previews for the branch.

environmentVariables

environmentVariables: Record<string, string> | undefined

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

framework

framework: string | undefined

The framework for a branch of an Amplify app.

Optional pullRequestEnvironmentName

pullRequestEnvironmentName: undefined | string

The Amplify environment name for the pull request.

Optional sourceBranch

sourceBranch: undefined | string

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

stage

stage: Stage | string | undefined

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

Optional tags

tags: Record<string, string>

The tag for the branch of an Amplify app.

Optional thumbnailUrl

thumbnailUrl: undefined | string

The thumbnail URL for the branch of an Amplify app.

totalNumberOfJobs

totalNumberOfJobs: string | undefined

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

ttl

ttl: string | undefined

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

updateTime

updateTime: Date | undefined

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