Package software.amazon.awscdk.services.amplify

Interface CfnBranchProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnBranchProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.119Z") @Stability(Stable) public interface CfnBranchProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnBranch.

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.*;
 CfnBranchProps cfnBranchProps = CfnBranchProps.builder()
         .appId("appId")
         .branchName("branchName")
         // the properties below are optional
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .enableBasicAuth(false)
                 .build())
         .buildSpec("buildSpec")
         .description("description")
         .enableAutoBuild(false)
         .enablePerformanceMode(false)
         .enablePullRequestPreview(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .framework("framework")
         .pullRequestEnvironmentName("pullRequestEnvironmentName")
         .stage("stage")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getAppId

      @Stability(Stable) @NotNull String getAppId()
      The unique ID for an Amplify app.

      Length Constraints: Minimum length of 1. Maximum length of 20.

      Pattern: d[a-z0-9]+

    • getBranchName

      @Stability(Stable) @NotNull String getBranchName()
      The name for the branch.

      Length Constraints: Minimum length of 1. Maximum length of 255.

      Pattern: (?s).+

    • getBasicAuthConfig

      @Stability(Stable) @Nullable default Object getBasicAuthConfig()
      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 .

    • getBuildSpec

      @Stability(Stable) @Nullable default String getBuildSpec()
      The build specification (build spec) for the branch.

      Length Constraints: Minimum length of 1. Maximum length of 25000.

      Pattern: (?s).+

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description for the branch that is part of an Amplify app.

      Length Constraints: Maximum length of 1000.

      Pattern: (?s).*

    • getEnableAutoBuild

      @Stability(Stable) @Nullable default Object getEnableAutoBuild()
      Enables auto building for the branch.

    • getEnablePerformanceMode

      @Stability(Stable) @Nullable default Object 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.

    • getEnablePullRequestPreview

      @Stability(Stable) @Nullable default Object getEnablePullRequestPreview()
      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 .

    • getEnvironmentVariables

      @Stability(Stable) @Nullable default Object getEnvironmentVariables()
      The environment variables for the branch.

    • getFramework

      @Stability(Stable) @Nullable default String getFramework()
      The framework for the branch.

    • getPullRequestEnvironmentName

      @Stability(Stable) @Nullable default String getPullRequestEnvironmentName()
      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 .

      Length Constraints: Maximum length of 20.

      Pattern: (?s).*

    • getStage

      @Stability(Stable) @Nullable default String getStage()
      Describes the current stage for the branch.

      Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The tag for the branch.

    • builder

      @Stability(Stable) static CfnBranchProps.Builder builder()
      Returns:
      a CfnBranchProps.Builder of CfnBranchProps