software.amazon.awscdk.services.amplify

Class CfnApp.AutoBranchCreationConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.CfnApp.AutoBranchCreationConfigProperty.Builder

Enclosing interface:

CfnApp.AutoBranchCreationConfigProperty

public static final class CfnApp.AutoBranchCreationConfigProperty.Builder
extends java.lang.Object

A builder for CfnApp.AutoBranchCreationConfigProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnApp.AutoBranchCreationConfigProperty.Builder	autoBranchCreationPatterns(java.util.List<java.lang.String> autoBranchCreationPatterns) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()
CfnApp.AutoBranchCreationConfigProperty.Builder	basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
CfnApp.AutoBranchCreationConfigProperty.Builder	basicAuthConfig(IResolvable basicAuthConfig) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
CfnApp.AutoBranchCreationConfigProperty	build() Builds the configured instance.
CfnApp.AutoBranchCreationConfigProperty.Builder	buildSpec(java.lang.String buildSpec) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBuildSpec()
CfnApp.AutoBranchCreationConfigProperty.Builder	enableAutoBranchCreation(java.lang.Boolean enableAutoBranchCreation) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
CfnApp.AutoBranchCreationConfigProperty.Builder	enableAutoBranchCreation(IResolvable enableAutoBranchCreation) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
CfnApp.AutoBranchCreationConfigProperty.Builder	enableAutoBuild(java.lang.Boolean enableAutoBuild) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
CfnApp.AutoBranchCreationConfigProperty.Builder	enableAutoBuild(IResolvable enableAutoBuild) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
CfnApp.AutoBranchCreationConfigProperty.Builder	enablePerformanceMode(java.lang.Boolean enablePerformanceMode) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
CfnApp.AutoBranchCreationConfigProperty.Builder	enablePerformanceMode(IResolvable enablePerformanceMode) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
CfnApp.AutoBranchCreationConfigProperty.Builder	enablePullRequestPreview(java.lang.Boolean enablePullRequestPreview) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
CfnApp.AutoBranchCreationConfigProperty.Builder	enablePullRequestPreview(IResolvable enablePullRequestPreview) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
CfnApp.AutoBranchCreationConfigProperty.Builder	environmentVariables(IResolvable environmentVariables) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
CfnApp.AutoBranchCreationConfigProperty.Builder	environmentVariables(java.util.List<? extends java.lang.Object> environmentVariables) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
CfnApp.AutoBranchCreationConfigProperty.Builder	pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getPullRequestEnvironmentName()
CfnApp.AutoBranchCreationConfigProperty.Builder	stage(java.lang.String stage) Sets the value of CfnApp.AutoBranchCreationConfigProperty.getStage()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

autoBranchCreationPatterns

public CfnApp.AutoBranchCreationConfigProperty.Builder autoBranchCreationPatterns(java.util.List<java.lang.String> autoBranchCreationPatterns)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()

Parameters:

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

Returns:

this

basicAuthConfig

public CfnApp.AutoBranchCreationConfigProperty.Builder basicAuthConfig(IResolvable basicAuthConfig)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()

Parameters:

basicAuthConfig - Sets password protection for your auto created branch.

Returns:

this

basicAuthConfig

public CfnApp.AutoBranchCreationConfigProperty.Builder basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()

Parameters:

basicAuthConfig - Sets password protection for your auto created branch.

Returns:

this

buildSpec

public CfnApp.AutoBranchCreationConfigProperty.Builder buildSpec(java.lang.String buildSpec)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getBuildSpec()

Parameters:

buildSpec - The build specification (build spec) for the autocreated branch. Length Constraints: Minimum length of 1. Maximum length of 25000.

Returns:

this

enableAutoBranchCreation

public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(java.lang.Boolean enableAutoBranchCreation)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify app.

Returns:

this

enableAutoBranchCreation

public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(IResolvable enableAutoBranchCreation)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify app.

Returns:

this

enableAutoBuild

public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBuild(java.lang.Boolean enableAutoBuild)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()

Parameters:

enableAutoBuild - Enables auto building for the auto created branch.

Returns:

this

enableAutoBuild

public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBuild(IResolvable enableAutoBuild)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()

Parameters:

enableAutoBuild - Enables auto building for the auto created branch.

Returns:

this

enablePerformanceMode

public CfnApp.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(java.lang.Boolean enablePerformanceMode)

Sets the value of CfnApp.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

public CfnApp.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(IResolvable enablePerformanceMode)

Sets the value of CfnApp.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

public CfnApp.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(java.lang.Boolean enablePullRequestPreview)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()

Parameters:

enablePullRequestPreview - Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app. Amplify Console 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, the Amplify Console 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

public CfnApp.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(IResolvable enablePullRequestPreview)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()

Parameters:

enablePullRequestPreview - Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app. Amplify Console 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, the Amplify Console 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

public CfnApp.AutoBranchCreationConfigProperty.Builder environmentVariables(IResolvable environmentVariables)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables for the auto created branch.

Returns:

this

environmentVariables

public CfnApp.AutoBranchCreationConfigProperty.Builder environmentVariables(java.util.List<? extends java.lang.Object> environmentVariables)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables for the auto created branch.

Returns:

this

pullRequestEnvironmentName

public CfnApp.AutoBranchCreationConfigProperty.Builder pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName)

Sets the value of CfnApp.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, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console 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 .

Length Constraints: Maximum length of 20.

Pattern: (?s).*

Returns:

this

stage

public CfnApp.AutoBranchCreationConfigProperty.Builder stage(java.lang.String stage)

Sets the value of CfnApp.AutoBranchCreationConfigProperty.getStage()

Parameters:

stage - Stage for the auto created branch.

Returns:

this

build

public CfnApp.AutoBranchCreationConfigProperty build()

Builds the configured instance.

Returns:

a new instance of CfnApp.AutoBranchCreationConfigProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided