Package software.amazon.awscdk.cfnpropertymixins.services.amplify

Class CfnBranchPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnBranchPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBranchPropsMixin>

Enclosing class:

CfnBranchPropsMixin

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

A fluent builder for CfnBranchPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnBranchPropsMixin.Builder	appId(String appId)	The unique ID for an Amplify app.
CfnBranchPropsMixin.Builder	backend(CfnBranchPropsMixin.BackendProperty backend)	The backend for a Branch of an Amplify app.
CfnBranchPropsMixin.Builder	backend(IResolvable backend)	The backend for a Branch of an Amplify app.
CfnBranchPropsMixin.Builder	basicAuthConfig(CfnBranchPropsMixin.BasicAuthConfigProperty basicAuthConfig)	The basic authorization credentials for a branch of an Amplify app.
CfnBranchPropsMixin.Builder	basicAuthConfig(IResolvable basicAuthConfig)	The basic authorization credentials for a branch of an Amplify app.
CfnBranchPropsMixin.Builder	branchName(String branchName)	The name for the branch.
CfnBranchPropsMixin	build()
CfnBranchPropsMixin.Builder	buildSpec(String buildSpec)	The build specification (build spec) for the branch.
CfnBranchPropsMixin.Builder	computeRoleArn(String computeRoleArn)	The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.
static CfnBranchPropsMixin.Builder	create()
static CfnBranchPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnBranchPropsMixin.Builder	description(String description)	The description for the branch that is part of an Amplify app.
CfnBranchPropsMixin.Builder	enableAutoBuild(Boolean enableAutoBuild)	Enables auto building for the branch.
CfnBranchPropsMixin.Builder	enableAutoBuild(IResolvable enableAutoBuild)	Enables auto building for the branch.
CfnBranchPropsMixin.Builder	enablePerformanceMode(Boolean enablePerformanceMode)	Enables performance mode for the branch.
CfnBranchPropsMixin.Builder	enablePerformanceMode(IResolvable enablePerformanceMode)	Enables performance mode for the branch.
CfnBranchPropsMixin.Builder	enablePullRequestPreview(Boolean enablePullRequestPreview)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
CfnBranchPropsMixin.Builder	enablePullRequestPreview(IResolvable enablePullRequestPreview)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
CfnBranchPropsMixin.Builder	enableSkewProtection(Boolean enableSkewProtection)	Specifies whether the skew protection feature is enabled for the branch.
CfnBranchPropsMixin.Builder	enableSkewProtection(IResolvable enableSkewProtection)	Specifies whether the skew protection feature is enabled for the branch.
CfnBranchPropsMixin.Builder	environmentVariables(List<? extends Object> environmentVariables)	The environment variables for the branch.
CfnBranchPropsMixin.Builder	environmentVariables(IResolvable environmentVariables)	The environment variables for the branch.
CfnBranchPropsMixin.Builder	framework(String framework)	The framework for the branch.
CfnBranchPropsMixin.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.
CfnBranchPropsMixin.Builder	stage(String stage)	Describes the current stage for the branch.
CfnBranchPropsMixin.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 CfnBranchPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnBranchPropsMixin.Builder.

create

@Stability(Stable)
public static CfnBranchPropsMixin.Builder create()

Returns:

a new instance of CfnBranchPropsMixin.Builder.

appId

@Stability(Stable)
public CfnBranchPropsMixin.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

backend

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

The backend for a Branch of an Amplify app. Use for a backend created from an 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 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 CfnBranchPropsMixin.Builder backend(CfnBranchPropsMixin.BackendProperty backend)

The backend for a Branch of an Amplify app. Use for a backend created from an 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 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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.Builder basicAuthConfig(CfnBranchPropsMixin.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

branchName

@Stability(Stable)
public CfnBranchPropsMixin.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

buildSpec

@Stability(Stable)
public CfnBranchPropsMixin.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

computeRoleArn

@Stability(Stable)
public CfnBranchPropsMixin.Builder computeRoleArn(String computeRoleArn)

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

Parameters:

computeRoleArn - The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR 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-computerolearn

description

@Stability(Stable)
public CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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

enableSkewProtection

@Stability(Stable)
public CfnBranchPropsMixin.Builder enableSkewProtection(Boolean enableSkewProtection)

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

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide .

Parameters:

enableSkewProtection - Specifies whether the skew protection feature is enabled 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-enableskewprotection

enableSkewProtection

@Stability(Stable)
public CfnBranchPropsMixin.Builder enableSkewProtection(IResolvable enableSkewProtection)

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

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide .

Parameters:

enableSkewProtection - Specifies whether the skew protection feature is enabled 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-enableskewprotection

environmentVariables

@Stability(Stable)
public CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin.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 CfnBranchPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnBranchPropsMixin.