Interface CfnApp.AutoBranchCreationConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApp.AutoBranchCreationConfigProperty.Jsii$Proxy
- Enclosing class:
CfnApp
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.amplify.*; AutoBranchCreationConfigProperty autoBranchCreationConfigProperty = AutoBranchCreationConfigProperty.builder() .autoBranchCreationPatterns(List.of("autoBranchCreationPatterns")) .basicAuthConfig(BasicAuthConfigProperty.builder() .enableBasicAuth(false) .password("password") .username("username") .build()) .buildSpec("buildSpec") .enableAutoBranchCreation(false) .enableAutoBuild(false) .enablePerformanceMode(false) .enablePullRequestPreview(false) .environmentVariables(List.of(EnvironmentVariableProperty.builder() .name("name") .value("value") .build())) .framework("framework") .pullRequestEnvironmentName("pullRequestEnvironmentName") .stage("stage") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApp.AutoBranchCreationConfigProperty
static final class
An implementation forCfnApp.AutoBranchCreationConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Automated branch creation glob patterns for the Amplify app.default Object
Sets password protection for your auto created branch.default String
The build specification (build spec) for the autocreated branch.default Object
Enables automated branch creation for the Amplify app.default Object
Enables auto building for the auto created branch.default Object
Enables performance mode for the branch.default Object
Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app.default Object
The environment variables for the autocreated branch.default String
The framework for the autocreated branch.default String
If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews.default String
getStage()
Stage for the auto created branch.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAutoBranchCreationPatterns
Automated branch creation glob patterns for the Amplify app.- See Also:
-
getBasicAuthConfig
Sets password protection for your auto created branch.- See Also:
-
getBuildSpec
The build specification (build spec) for the autocreated branch.- See Also:
-
getEnableAutoBranchCreation
Enables automated branch creation for the Amplify app.- See Also:
-
getEnableAutoBuild
Enables auto building for the auto created branch.- See Also:
-
getEnablePerformanceMode
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.
- See Also:
-
getEnablePullRequestPreview
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 .
- See Also:
-
getEnvironmentVariables
The environment variables for the autocreated branch.- See Also:
-
getFramework
The framework for the autocreated branch.- See Also:
-
getPullRequestEnvironmentName
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
, 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 .
- See Also:
-
getStage
Stage for the auto created branch.- See Also:
-
builder
-