Package software.amazon.awscdk.services.amplify

Class CfnBranch.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.CfnBranch.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBranch>

Enclosing class:

CfnBranch

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

A fluent builder for CfnBranch.

Method Summary

Modifier and Type	Method	Description
CfnBranch.Builder	appId(String appId)	The unique ID for an Amplify app.
CfnBranch.Builder	backend(IResolvable backend)	The backend for a Branch of an Amplify app.
CfnBranch.Builder	backend(CfnBranch.BackendProperty backend)	The backend for a Branch of an Amplify app.
CfnBranch.Builder	basicAuthConfig(IResolvable basicAuthConfig)	The basic authorization credentials for a branch of an Amplify app.
CfnBranch.Builder	basicAuthConfig(CfnBranch.BasicAuthConfigProperty basicAuthConfig)	The basic authorization credentials for a branch of an Amplify app.
CfnBranch.Builder	branchName(String branchName)	The name for the branch.
CfnBranch	build()
CfnBranch.Builder	buildSpec(String buildSpec)	The build specification (build spec) for the branch.
static CfnBranch.Builder	create(software.constructs.Construct scope, String id)
CfnBranch.Builder	description(String description)	The description for the branch that is part of an Amplify app.
CfnBranch.Builder	enableAutoBuild(Boolean enableAutoBuild)	Enables auto building for the branch.
CfnBranch.Builder	enableAutoBuild(IResolvable enableAutoBuild)	Enables auto building for the branch.
CfnBranch.Builder	enablePerformanceMode(Boolean enablePerformanceMode)	Enables performance mode for the branch.
CfnBranch.Builder	enablePerformanceMode(IResolvable enablePerformanceMode)	Enables performance mode for the branch.
CfnBranch.Builder	enablePullRequestPreview(Boolean enablePullRequestPreview)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
CfnBranch.Builder	enablePullRequestPreview(IResolvable enablePullRequestPreview)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
CfnBranch.Builder	environmentVariables(List<? extends Object> environmentVariables)	The environment variables for the branch.
CfnBranch.Builder	environmentVariables(IResolvable environmentVariables)	The environment variables for the branch.
CfnBranch.Builder	framework(String framework)	The framework for the branch.
CfnBranch.Builder	pullRequestEnvironmentName(String pullRequestEnvironmentName)	If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
CfnBranch.Builder	stage(String stage)	Describes the current stage for the branch.
CfnBranch.Builder	tags(List<? extends CfnTag> tags)	The tag for the branch.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnBranch.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnBranch.Builder.

appId

@Stability(Stable)
public CfnBranch.Builder appId(String appId)

The unique ID for an Amplify app.

Parameters:

appId - The unique ID for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid

branchName

@Stability(Stable)
public CfnBranch.Builder branchName(String branchName)

The name for the branch.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname

backend

@Stability(Stable)
public CfnBranch.Builder backend(IResolvable backend)

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.

Parameters:

backend - The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-backend

backend

@Stability(Stable)
public CfnBranch.Builder backend(CfnBranch.BackendProperty backend)

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.

Parameters:

backend - The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-backend

basicAuthConfig

@Stability(Stable)
public CfnBranch.Builder basicAuthConfig(IResolvable basicAuthConfig)

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 .

Parameters:

basicAuthConfig - The basic authorization credentials for a branch of an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig

basicAuthConfig

@Stability(Stable)
public CfnBranch.Builder basicAuthConfig(CfnBranch.BasicAuthConfigProperty basicAuthConfig)

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 .

Parameters:

basicAuthConfig - The basic authorization credentials for a branch of an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig

buildSpec

@Stability(Stable)
public CfnBranch.Builder buildSpec(String buildSpec)

The build specification (build spec) for the branch.

Parameters:

buildSpec - The build specification (build spec) for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec

description

@Stability(Stable)
public CfnBranch.Builder description(String description)

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

Parameters:

description - The description for the branch that is part of an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description

enableAutoBuild

@Stability(Stable)
public CfnBranch.Builder enableAutoBuild(Boolean enableAutoBuild)

Enables auto building for the branch.

Parameters:

enableAutoBuild - Enables auto building for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild

enableAutoBuild

@Stability(Stable)
public CfnBranch.Builder enableAutoBuild(IResolvable enableAutoBuild)

Enables auto building for the branch.

Parameters:

enableAutoBuild - Enables auto building for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild

enablePerformanceMode

@Stability(Stable)
public CfnBranch.Builder enablePerformanceMode(Boolean enablePerformanceMode)

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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode

enablePerformanceMode

@Stability(Stable)
public CfnBranch.Builder enablePerformanceMode(IResolvable enablePerformanceMode)

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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode

enablePullRequestPreview

@Stability(Stable)
public CfnBranch.Builder enablePullRequestPreview(Boolean enablePullRequestPreview)

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 .

Parameters:

enablePullRequestPreview - Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview

enablePullRequestPreview

@Stability(Stable)
public CfnBranch.Builder enablePullRequestPreview(IResolvable enablePullRequestPreview)

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 .

Parameters:

enablePullRequestPreview - Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview

environmentVariables

@Stability(Stable)
public CfnBranch.Builder environmentVariables(IResolvable environmentVariables)

The environment variables for the branch.

Parameters:

environmentVariables - The environment variables for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables

environmentVariables

@Stability(Stable)
public CfnBranch.Builder environmentVariables(List<? extends Object> environmentVariables)

The environment variables for the branch.

Parameters:

environmentVariables - The environment variables for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables

framework

@Stability(Stable)
public CfnBranch.Builder framework(String framework)

The framework for the branch.

Parameters:

framework - The framework for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-framework

pullRequestEnvironmentName

@Stability(Stable)
public CfnBranch.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName)

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 .

Parameters:

pullRequestEnvironmentName - If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname

stage

@Stability(Stable)
public CfnBranch.Builder stage(String stage)

Describes the current stage for the branch.

Parameters:

stage - Describes the current stage for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage

tags

@Stability(Stable)
public CfnBranch.Builder tags(List<? extends CfnTag> tags)

The tag for the branch.

Parameters:

tags - The tag for the branch. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags

build

@Stability(Stable)
public CfnBranch build()

Specified by:

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

Returns:

a newly built instance of CfnBranch.