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

Class CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAppPropsMixin.AutoBranchCreationConfigProperty>

Enclosing interface:

CfnAppPropsMixin.AutoBranchCreationConfigProperty

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

A builder for CfnAppPropsMixin.AutoBranchCreationConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	autoBranchCreationPatterns(List<String> autoBranchCreationPatterns)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBasicAuthConfig()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	basicAuthConfig(IResolvable basicAuthConfig)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBasicAuthConfig()
CfnAppPropsMixin.AutoBranchCreationConfigProperty	build()	Builds the configured instance.
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	buildSpec(String buildSpec)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBuildSpec()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enableAutoBranchCreation(Boolean enableAutoBranchCreation)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enableAutoBranchCreation(IResolvable enableAutoBranchCreation)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enableAutoBuild(Boolean enableAutoBuild)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBuild()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enableAutoBuild(IResolvable enableAutoBuild)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBuild()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enablePerformanceMode(Boolean enablePerformanceMode)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enablePerformanceMode(IResolvable enablePerformanceMode)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enablePullRequestPreview(Boolean enablePullRequestPreview)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	enablePullRequestPreview(IResolvable enablePullRequestPreview)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	environmentVariables(List<? extends Object> environmentVariables)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnvironmentVariables()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	environmentVariables(IResolvable environmentVariables)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnvironmentVariables()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	framework(String framework)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getFramework()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	pullRequestEnvironmentName(String pullRequestEnvironmentName)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getPullRequestEnvironmentName()
CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder	stage(String stage)	Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.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

autoBranchCreationPatterns

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder autoBranchCreationPatterns(List<String> autoBranchCreationPatterns)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()

Parameters:

autoBranchCreationPatterns - Automated branch creation glob patterns for the Amplify app.

Returns:

this

basicAuthConfig

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder basicAuthConfig(IResolvable basicAuthConfig)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBasicAuthConfig()

Parameters:

basicAuthConfig - Sets password protection for your auto created branch.

Returns:

this

basicAuthConfig

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBasicAuthConfig()

Parameters:

basicAuthConfig - Sets password protection for your auto created branch.

Returns:

this

buildSpec

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder buildSpec(String buildSpec)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getBuildSpec()

Parameters:

buildSpec - The build specification (build spec) for the autocreated branch.

Returns:

this

enableAutoBranchCreation

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(Boolean enableAutoBranchCreation)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify app.

Returns:

this

enableAutoBranchCreation

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(IResolvable enableAutoBranchCreation)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify app.

Returns:

this

enableAutoBuild

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enableAutoBuild(Boolean enableAutoBuild)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBuild()

Parameters:

enableAutoBuild - Enables auto building for the auto created branch.

Returns:

this

enableAutoBuild

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enableAutoBuild(IResolvable enableAutoBuild)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnableAutoBuild()

Parameters:

enableAutoBuild - Enables auto building for the auto created branch.

Returns:

this

enablePerformanceMode

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(Boolean enablePerformanceMode)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePerformanceMode()

Parameters:

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.

Returns:

this

enablePerformanceMode

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(IResolvable enablePerformanceMode)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePerformanceMode()

Parameters:

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.

Returns:

this

enablePullRequestPreview

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(Boolean enablePullRequestPreview)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()

Parameters:

enablePullRequestPreview - Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. 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 Hosting 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 .

Returns:

this

enablePullRequestPreview

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(IResolvable enablePullRequestPreview)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()

Parameters:

enablePullRequestPreview - Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. 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 Hosting 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 .

Returns:

this

environmentVariables

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder environmentVariables(IResolvable environmentVariables)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - The environment variables for the autocreated branch.

Returns:

this

environmentVariables

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

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - The environment variables for the autocreated branch.

Returns:

this

framework

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder framework(String framework)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getFramework()

Parameters:

framework - The framework for the autocreated branch.

Returns:

this

pullRequestEnvironmentName

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getPullRequestEnvironmentName()

Parameters:

pullRequestEnvironmentName - If pull request previews are enabled, 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.

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

Returns:

this

stage

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty.Builder stage(String stage)

Sets the value of CfnAppPropsMixin.AutoBranchCreationConfigProperty.getStage()

Parameters:

stage - Stage for the auto created branch.

Returns:

this

build

@Stability(Stable)
public CfnAppPropsMixin.AutoBranchCreationConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAppPropsMixin.AutoBranchCreationConfigProperty>

Returns:

a new instance of CfnAppPropsMixin.AutoBranchCreationConfigProperty

Throws:

NullPointerException - if any required attribute was not provided