Class CfnApp.AutoBranchCreationConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApp.AutoBranchCreationConfigProperty>
- Enclosing interface:
- CfnApp.AutoBranchCreationConfigProperty
CfnApp.AutoBranchCreationConfigProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionautoBranchCreationPatterns
(List<String> autoBranchCreationPatterns) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()
basicAuthConfig
(IResolvable basicAuthConfig) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
basicAuthConfig
(CfnApp.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
build()
Builds the configured instance.Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getBuildSpec()
enableAutoBranchCreation
(Boolean enableAutoBranchCreation) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
enableAutoBranchCreation
(IResolvable enableAutoBranchCreation) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
enableAutoBuild
(Boolean enableAutoBuild) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
enableAutoBuild
(IResolvable enableAutoBuild) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
enablePerformanceMode
(Boolean enablePerformanceMode) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
enablePerformanceMode
(IResolvable enablePerformanceMode) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnablePerformanceMode()
enablePullRequestPreview
(Boolean enablePullRequestPreview) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
enablePullRequestPreview
(IResolvable enablePullRequestPreview) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnablePullRequestPreview()
environmentVariables
(List<? extends Object> environmentVariables) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
environmentVariables
(IResolvable environmentVariables) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getFramework()
pullRequestEnvironmentName
(String pullRequestEnvironmentName) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getPullRequestEnvironmentName()
Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getStage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
autoBranchCreationPatterns
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder autoBranchCreationPatterns(List<String> autoBranchCreationPatterns) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getAutoBranchCreationPatterns()
- Parameters:
autoBranchCreationPatterns
- Automated branch creation glob patterns for the Amplify app.- Returns:
this
-
basicAuthConfig
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder basicAuthConfig(IResolvable basicAuthConfig) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
- Parameters:
basicAuthConfig
- Sets password protection for your auto created branch.- Returns:
this
-
basicAuthConfig
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getBasicAuthConfig()
- Parameters:
basicAuthConfig
- Sets password protection for your auto created branch.- Returns:
this
-
buildSpec
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder buildSpec(String buildSpec) Sets the value ofCfnApp.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
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(Boolean enableAutoBranchCreation) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
- Parameters:
enableAutoBranchCreation
- Enables automated branch creation for the Amplify app.- Returns:
this
-
enableAutoBranchCreation
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBranchCreation(IResolvable enableAutoBranchCreation) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBranchCreation()
- Parameters:
enableAutoBranchCreation
- Enables automated branch creation for the Amplify app.- Returns:
this
-
enableAutoBuild
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBuild(Boolean enableAutoBuild) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
- Parameters:
enableAutoBuild
- Enables auto building for the auto created branch.- Returns:
this
-
enableAutoBuild
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder enableAutoBuild(IResolvable enableAutoBuild) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnableAutoBuild()
- Parameters:
enableAutoBuild
- Enables auto building for the auto created branch.- Returns:
this
-
enablePerformanceMode
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(Boolean enablePerformanceMode) Sets the value ofCfnApp.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 CfnApp.AutoBranchCreationConfigProperty.Builder enablePerformanceMode(IResolvable enablePerformanceMode) Sets the value ofCfnApp.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 CfnApp.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(Boolean enablePullRequestPreview) Sets the value ofCfnApp.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 CfnApp.AutoBranchCreationConfigProperty.Builder enablePullRequestPreview(IResolvable enablePullRequestPreview) Sets the value ofCfnApp.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 CfnApp.AutoBranchCreationConfigProperty.Builder environmentVariables(IResolvable environmentVariables) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
- Parameters:
environmentVariables
- Environment variables for the auto created branch.- Returns:
this
-
environmentVariables
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder environmentVariables(List<? extends Object> environmentVariables) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getEnvironmentVariables()
- Parameters:
environmentVariables
- Environment variables for the auto created branch.- Returns:
this
-
framework
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder framework(String framework) Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getFramework()
- Parameters:
framework
- The framework for the autocreated branch.- Returns:
this
-
pullRequestEnvironmentName
@Stability(Stable) public CfnApp.AutoBranchCreationConfigProperty.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName) Sets the value ofCfnApp.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 namedprod
,test
, ordev
that you initialized with the Amplify CLI.To enable pull request previews, set the
EnablePullRequestPreview
property totrue
.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 .
Length Constraints: Maximum length of 20.
Pattern: (?s).*
- Returns:
this
-
stage
Sets the value ofCfnApp.AutoBranchCreationConfigProperty.getStage()
- Parameters:
stage
- Stage for the auto created branch.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnApp.AutoBranchCreationConfigProperty>
- Returns:
- a new instance of
CfnApp.AutoBranchCreationConfigProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-