pulumi-aws-native-kotlin/com.pulumi.awsnative.amplify.kotlin.outputs/GetBranchResult

GetBranchResult

data class GetBranchResult(val arn: String? = null, val backend: BranchBackend? = null, val buildSpec: String? = null, val description: String? = null, val enableAutoBuild: Boolean? = null, val enablePerformanceMode: Boolean? = null, val enablePullRequestPreview: Boolean? = null, val environmentVariables: List<BranchEnvironmentVariable>? = null, val framework: String? = null, val pullRequestEnvironmentName: String? = null, val stage: BranchStage? = null, val tags: List<Tag>? = null)

Constructors

GetBranchResult

constructor(arn: String? = null, backend: BranchBackend? = null, buildSpec: String? = null, description: String? = null, enableAutoBuild: Boolean? = null, enablePerformanceMode: Boolean? = null, enablePullRequestPreview: Boolean? = null, environmentVariables: List<BranchEnvironmentVariable>? = null, framework: String? = null, pullRequestEnvironmentName: String? = null, stage: BranchStage? = null, tags: List<Tag>? = null)

Types

Companion

object Companion

Properties

arn

val arn: String? = null

ARN for a branch, part of an Amplify App.

backend

val backend: BranchBackend? = null

The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This field 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.

buildSpec

val buildSpec: String? = null

The build specification (build spec) for the branch.

description

val description: String? = null

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

enableAutoBuild

val enableAutoBuild: Boolean? = null

Enables auto building for the branch.

enablePerformanceMode

val enablePerformanceMode: Boolean? = null

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

val enablePullRequestPreview: Boolean? = null

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName property. For more information, see Web Previews in the AWS Amplify Hosting User Guide .

environmentVariables

val environmentVariables: List<BranchEnvironmentVariable>? = null

The environment variables for the branch.

framework

val framework: String? = null

The framework for the branch.

pullRequestEnvironmentName

val pullRequestEnvironmentName: String? = null

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named prod , test , or dev that you initialized with the Amplify CLI and mapped to this branch. To enable pull request previews, set the EnablePullRequestPreview property to true . If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed. For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide .

stage

val stage: BranchStage? = null

Describes the current stage for the branch.