Package software.amazon.awscdk.services.amplify

Class BranchProps.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.BranchProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BranchProps>

Enclosing interface:

BranchProps

@Stability(Experimental)
public static final class BranchProps.Builder
extends Object
implements software.amazon.jsii.Builder<BranchProps>

A builder for BranchProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BranchProps.Builder	app(IApp app)	Sets the value of BranchProps.getApp()
BranchProps.Builder	asset(Asset asset)	Sets the value of BranchOptions.getAsset()
BranchProps.Builder	autoBuild(Boolean autoBuild)	Sets the value of BranchOptions.getAutoBuild()
BranchProps.Builder	basicAuth(BasicAuth basicAuth)	Sets the value of BranchOptions.getBasicAuth()
BranchProps.Builder	branchName(String branchName)	Sets the value of BranchOptions.getBranchName()
BranchProps	build()	Builds the configured instance.
BranchProps.Builder	buildSpec(BuildSpec buildSpec)	Sets the value of BranchOptions.getBuildSpec()
BranchProps.Builder	description(String description)	Sets the value of BranchOptions.getDescription()
BranchProps.Builder	environmentVariables(Map<String,String> environmentVariables)	Sets the value of BranchOptions.getEnvironmentVariables()
BranchProps.Builder	performanceMode(Boolean performanceMode)	Sets the value of BranchOptions.getPerformanceMode()
BranchProps.Builder	pullRequestEnvironmentName(String pullRequestEnvironmentName)	Sets the value of BranchOptions.getPullRequestEnvironmentName()
BranchProps.Builder	pullRequestPreview(Boolean pullRequestPreview)	Sets the value of BranchOptions.getPullRequestPreview()
BranchProps.Builder	stage(String stage)	Sets the value of BranchOptions.getStage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

app

@Stability(Experimental)
public BranchProps.Builder app(IApp app)

Sets the value of BranchProps.getApp()

Parameters:

app - The application within which the branch must be created. This parameter is required.

Returns:

this

asset

@Stability(Experimental)
public BranchProps.Builder asset(Asset asset)

Sets the value of BranchOptions.getAsset()

Parameters:

asset - Asset for deployment. The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's startDeployment API to initiate and deploy a S3 asset onto the App.

Returns:

this

autoBuild

@Stability(Experimental)
public BranchProps.Builder autoBuild(Boolean autoBuild)

Sets the value of BranchOptions.getAutoBuild()

Parameters:

autoBuild - Whether to enable auto building for the branch.

Returns:

this

basicAuth

@Stability(Experimental)
public BranchProps.Builder basicAuth(BasicAuth basicAuth)

Sets the value of BranchOptions.getBasicAuth()

Parameters:

basicAuth - The Basic Auth configuration. Use this to set password protection for the branch

Returns:

this

branchName

@Stability(Experimental)
public BranchProps.Builder branchName(String branchName)

Sets the value of BranchOptions.getBranchName()

Parameters:

branchName - The name of the branch.

Returns:

this

buildSpec

@Stability(Experimental)
public BranchProps.Builder buildSpec(BuildSpec buildSpec)

Sets the value of BranchOptions.getBuildSpec()

Parameters:

buildSpec - BuildSpec for the branch.

Returns:

this

description

@Stability(Experimental)
public BranchProps.Builder description(String description)

Sets the value of BranchOptions.getDescription()

Parameters:

description - A description for the branch.

Returns:

this

environmentVariables

@Stability(Experimental)
public BranchProps.Builder environmentVariables(Map<String,String> environmentVariables)

Sets the value of BranchOptions.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables for the branch. All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

Returns:

this

performanceMode

@Stability(Experimental)
public BranchProps.Builder performanceMode(Boolean performanceMode)

Sets the value of BranchOptions.getPerformanceMode()

Parameters:

performanceMode - 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.

Returns:

this

pullRequestEnvironmentName

@Stability(Experimental)
public BranchProps.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName)

Sets the value of BranchOptions.getPullRequestEnvironmentName()

Parameters:

pullRequestEnvironmentName - The dedicated backend environment for the pull request previews.

Returns:

this

pullRequestPreview

@Stability(Experimental)
public BranchProps.Builder pullRequestPreview(Boolean pullRequestPreview)

Sets the value of BranchOptions.getPullRequestPreview()

Parameters:

pullRequestPreview - Whether to enable pull request preview for the branch.

Returns:

this

stage

@Stability(Experimental)
public BranchProps.Builder stage(String stage)

Sets the value of BranchOptions.getStage()

Parameters:

stage - Stage for the branch.

Returns:

this

build

@Stability(Experimental)
public BranchProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BranchProps>

Returns:

a new instance of BranchProps

Throws:

NullPointerException - if any required attribute was not provided