Branch

class Branch

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Describes the backend properties associated with an Amplify Branch.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The custom domains for a branch of an Amplify app.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Enables basic authorization for a branch of an Amplify app.

Link copied to clipboard

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

Link copied to clipboard

Enables performance mode for the branch.

Link copied to clipboard

Enables pull request previews for the branch.

Link copied to clipboard

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

Link copied to clipboard

The framework for a branch of an Amplify app.

Link copied to clipboard

The Amplify environment name for the pull request.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The tag for the branch of an Amplify app.

Link copied to clipboard

The thumbnail URL for the branch of an Amplify app.

Link copied to clipboard

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

Link copied to clipboard
val ttl: String

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Branch.Builder.() -> Unit = {}): Branch
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String