software.amazon.awscdk.services.amplify

Class Branch.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.Branch.Builder

Enclosing class:

Branch

public static final class Branch.Builder
extends java.lang.Object

(experimental) A fluent builder for Branch.

Method Summary

Modifier and Type	Method and Description
Branch.Builder	app(IApp app) (experimental) The application within which the branch must be created.
Branch.Builder	asset(Asset asset) (experimental) Asset for deployment.
Branch.Builder	autoBuild(java.lang.Boolean autoBuild) (experimental) Whether to enable auto building for the branch.
Branch.Builder	basicAuth(BasicAuth basicAuth) (experimental) The Basic Auth configuration.
Branch.Builder	branchName(java.lang.String branchName) (experimental) The name of the branch.
Branch	build()
Branch.Builder	buildSpec(BuildSpec buildSpec) (experimental) BuildSpec for the branch.
static Branch.Builder	create(software.constructs.Construct scope, java.lang.String id)
Branch.Builder	description(java.lang.String description) (experimental) A description for the branch.
Branch.Builder	environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables) (experimental) Environment variables for the branch.
Branch.Builder	performanceMode(java.lang.Boolean performanceMode) (experimental) Enables performance mode for the branch.
Branch.Builder	pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName) (experimental) The dedicated backend environment for the pull request previews.
Branch.Builder	pullRequestPreview(java.lang.Boolean pullRequestPreview) (experimental) Whether to enable pull request preview for the branch.
Branch.Builder	stage(java.lang.String stage) (experimental) Stage for the branch.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Branch.Builder create(software.constructs.Construct scope,
                                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Branch.Builder.

asset

public Branch.Builder asset(Asset asset)

(experimental) 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.

Default: - no asset

Parameters:

asset - Asset for deployment. This parameter is required.

Returns:

this

autoBuild

public Branch.Builder autoBuild(java.lang.Boolean autoBuild)

(experimental) Whether to enable auto building for the branch.

Default: true

Parameters:

autoBuild - Whether to enable auto building for the branch. This parameter is required.

Returns:

this

basicAuth

public Branch.Builder basicAuth(BasicAuth basicAuth)

(experimental) The Basic Auth configuration.

Use this to set password protection for the branch

Default: - no password protection

Parameters:

basicAuth - The Basic Auth configuration. This parameter is required.

Returns:

this

branchName

public Branch.Builder branchName(java.lang.String branchName)

(experimental) The name of the branch.

Default: - the construct's id

Parameters:

branchName - The name of the branch. This parameter is required.

Returns:

this

buildSpec

public Branch.Builder buildSpec(BuildSpec buildSpec)

(experimental) BuildSpec for the branch.

Default: - no build spec

Parameters:

buildSpec - BuildSpec for the branch. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

description

public Branch.Builder description(java.lang.String description)

(experimental) A description for the branch.

Default: - no description

Parameters:

description - A description for the branch. This parameter is required.

Returns:

this

environmentVariables

public Branch.Builder environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables)

(experimental) 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.

Default: - application environment variables

Parameters:

environmentVariables - Environment variables for the branch. This parameter is required.

Returns:

this

performanceMode

public Branch.Builder performanceMode(java.lang.Boolean performanceMode)

(experimental) 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.

Default: false

Parameters:

performanceMode - Enables performance mode for the branch. This parameter is required.

Returns:

this

pullRequestEnvironmentName

public Branch.Builder pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName)

(experimental) The dedicated backend environment for the pull request previews.

Default: - automatically provision a temporary backend

Parameters:

pullRequestEnvironmentName - The dedicated backend environment for the pull request previews. This parameter is required.

Returns:

this

pullRequestPreview

public Branch.Builder pullRequestPreview(java.lang.Boolean pullRequestPreview)

(experimental) Whether to enable pull request preview for the branch.

Default: true

Parameters:

pullRequestPreview - Whether to enable pull request preview for the branch. This parameter is required.

Returns:

this

stage

public Branch.Builder stage(java.lang.String stage)

(experimental) Stage for the branch.

Default: - no stage

Parameters:

stage - Stage for the branch. This parameter is required.

Returns:

this

app

public Branch.Builder app(IApp app)

(experimental) The application within which the branch must be created.

Parameters:

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

Returns:

this

build

public Branch build()