Builder

class Builder

Properties

Link copied to clipboard

The unique ID for an Amplify app.

Link copied to clipboard

The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The name for the branch.

Link copied to clipboard

The build specification (build spec) for the branch.

Link copied to clipboard

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.

Link copied to clipboard

The description for the branch.

Link copied to clipboard

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

Link copied to clipboard

Enables auto building for the branch.

Link copied to clipboard

Enables basic authorization for the branch.

Link copied to clipboard

Enables notifications for the branch.

Link copied to clipboard

Enables performance mode for the branch.

Link copied to clipboard

Enables pull request previews for this branch.

Link copied to clipboard

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

Link copied to clipboard

The environment variables for the branch.

Link copied to clipboard

The framework for the branch.

Link copied to clipboard

The Amplify environment name for the pull request.

Link copied to clipboard
var stage: Stage?

Describes the current stage for the branch.

Link copied to clipboard

The tag for the branch.

Link copied to clipboard
var ttl: String?

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

Functions

Link copied to clipboard
fun backend(block: Backend.Builder.() -> Unit)