amplify/aws.sdk.kotlin.services.amplify.model/Branch

Branch

class Branch

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

Types

object Companion

Properties

val activeJobId: String

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

associatedResources

val associatedResources: List<String>?

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

val backend: Backend?

Describes the backend associated with an Amplify Branch.

backendEnvironmentArn

val backendEnvironmentArn: String?

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

basicAuthCredentials

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

val branchArn: String

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

val branchName: String

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

val buildSpec: String?

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

val computeRoleArn: 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.

val createTime: Instant

A timestamp of when Amplify created the branch.

val customDomains: List<String>

The custom domains for a branch of an Amplify app.

val description: String

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

destinationBranch

val destinationBranch: String?

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

val displayName: String

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

enableAutoBuild

val enableAutoBuild: Boolean

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

enableBasicAuth

val enableBasicAuth: Boolean

Enables basic authorization for a branch of an Amplify app.

enableNotification

val enableNotification: Boolean

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

enablePerformanceMode

val enablePerformanceMode: Boolean?

Enables performance mode for the branch.

enablePullRequestPreview

val enablePullRequestPreview: Boolean

Enables pull request previews for the branch.

enableSkewProtection

val enableSkewProtection: Boolean?

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

environmentVariables

val environmentVariables: Map<String, String>

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

val framework: String

The framework for a branch of an Amplify app.

pullRequestEnvironmentName

val pullRequestEnvironmentName: String?

The Amplify environment name for the pull request.

val sourceBranch: String?

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

val stage: Stage

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

val tags: Map<String, String>?

The tag for the branch of an Amplify app.

val thumbnailUrl: String?

The thumbnail URL for the branch of an Amplify app.

totalNumberOfJobs

val totalNumberOfJobs: String

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

val ttl: String

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

val updateTime: Instant

A timestamp for the last updated time for a branch.

Functions

inline fun copy(block: Branch.Builder.() -> Unit = {}): Branch

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String