Package software.amazon.awscdk.services.amplify

Class CfnBranch

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.amplify.CfnBranch
All Implemented Interfaces:
IInspectable, IBranchRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:27.494Z") @Stability(Stable) public class CfnBranch extends CfnResource implements IInspectable, IBranchRef, ITaggable
The AWS::Amplify::Branch resource specifies a new branch within an app.

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.*;
 CfnBranch cfnBranch = CfnBranch.Builder.create(this, "MyCfnBranch")
         .appId("appId")
         .branchName("branchName")
         // the properties below are optional
         .backend(BackendProperty.builder()
                 .stackArn("stackArn")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .enableBasicAuth(false)
                 .build())
         .buildSpec("buildSpec")
         .computeRoleArn("computeRoleArn")
         .description("description")
         .enableAutoBuild(false)
         .enablePerformanceMode(false)
         .enablePullRequestPreview(false)
         .enableSkewProtection(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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBranch

      protected CfnBranch(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBranch

      protected CfnBranch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBranch

      @Stability(Stable) public CfnBranch(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBranchProps props)
      Create a new AWS::Amplify::Branch.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForBranch

      @Stability(Stable) @NotNull public static String arnForBranch(@NotNull IBranchRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnBranch

      @Stability(Stable) @NotNull public static Boolean isCfnBranch(@NotNull Object x)
      Checks whether the given object is a CfnBranch.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      ARN for a branch, part of an Amplify App.

    • getAttrBranchName

      @Stability(Stable) @NotNull public String getAttrBranchName()
      Name for a branch, part of an Amplify App.

    • getBranchRef

      @Stability(Stable) @NotNull public BranchReference getBranchRef()
      A reference to a Branch resource.
      Specified by:
      getBranchRef in interface IBranchRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAppId

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

    • setAppId

      @Stability(Stable) public void setAppId(@NotNull String value)
      The unique ID for an Amplify app.

    • getBranchName

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

    • setBranchName

      @Stability(Stable) public void setBranchName(@NotNull String value)
      The name for the branch.

    • getBackend

      @Stability(Stable) @Nullable public Object getBackend()
      The backend for a Branch of an Amplify app.

      Use for a backend created from an CloudFormation stack.

      Returns union: either IResolvable or CfnBranch.BackendProperty

    • setBackend

      @Stability(Stable) public void setBackend(@Nullable IResolvable value)
      The backend for a Branch of an Amplify app.

      Use for a backend created from an CloudFormation stack.

    • setBackend

      @Stability(Stable) public void setBackend(@Nullable CfnBranch.BackendProperty value)
      The backend for a Branch of an Amplify app.

      Use for a backend created from an CloudFormation stack.

    • getBasicAuthConfig

      @Stability(Stable) @Nullable public Object getBasicAuthConfig()
      The basic authorization credentials for a branch of an Amplify app.

      Returns union: either IResolvable or CfnBranch.BasicAuthConfigProperty

    • setBasicAuthConfig

      @Stability(Stable) public void setBasicAuthConfig(@Nullable IResolvable value)
      The basic authorization credentials for a branch of an Amplify app.

    • setBasicAuthConfig

      @Stability(Stable) public void setBasicAuthConfig(@Nullable CfnBranch.BasicAuthConfigProperty value)
      The basic authorization credentials for a branch of an Amplify app.

    • getBuildSpec

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

    • setBuildSpec

      @Stability(Stable) public void setBuildSpec(@Nullable String value)
      The build specification (build spec) for the branch.

    • getComputeRoleArn

      @Stability(Stable) @Nullable public String getComputeRoleArn()
      The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

    • setComputeRoleArn

      @Stability(Stable) public void setComputeRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

    • getDescription

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the branch that is part of an Amplify app.

    • getEnableAutoBuild

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

      Returns union: either Boolean or IResolvable

    • setEnableAutoBuild

      @Stability(Stable) public void setEnableAutoBuild(@Nullable Boolean value)
      Enables auto building for the branch.

    • setEnableAutoBuild

      @Stability(Stable) public void setEnableAutoBuild(@Nullable IResolvable value)
      Enables auto building for the branch.

    • getEnablePerformanceMode

      @Stability(Stable) @Nullable public Object getEnablePerformanceMode()
      Enables performance mode for the branch.

      Returns union: either Boolean or IResolvable

    • setEnablePerformanceMode

      @Stability(Stable) public void setEnablePerformanceMode(@Nullable Boolean value)
      Enables performance mode for the branch.

    • setEnablePerformanceMode

      @Stability(Stable) public void setEnablePerformanceMode(@Nullable IResolvable value)
      Enables performance mode for the branch.

    • getEnablePullRequestPreview

      @Stability(Stable) @Nullable public Object getEnablePullRequestPreview()
      Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

      Returns union: either Boolean or IResolvable

    • setEnablePullRequestPreview

      @Stability(Stable) public void setEnablePullRequestPreview(@Nullable Boolean value)
      Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

    • setEnablePullRequestPreview

      @Stability(Stable) public void setEnablePullRequestPreview(@Nullable IResolvable value)
      Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

    • getEnableSkewProtection

      @Stability(Stable) @Nullable public Object getEnableSkewProtection()
      Specifies whether the skew protection feature is enabled for the branch.

      Returns union: either Boolean or IResolvable

    • setEnableSkewProtection

      @Stability(Stable) public void setEnableSkewProtection(@Nullable Boolean value)
      Specifies whether the skew protection feature is enabled for the branch.

    • setEnableSkewProtection

      @Stability(Stable) public void setEnableSkewProtection(@Nullable IResolvable value)
      Specifies whether the skew protection feature is enabled for the branch.

    • getEnvironmentVariables

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBranch.EnvironmentVariableProperty>

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable IResolvable value)
      The environment variables for the branch.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable List<Object> value)
      The environment variables for the branch.

    • getFramework

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

    • setFramework

      @Stability(Stable) public void setFramework(@Nullable String value)
      The framework for the branch.

    • getPullRequestEnvironmentName

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

    • setPullRequestEnvironmentName

      @Stability(Stable) public void setPullRequestEnvironmentName(@Nullable String value)
      If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.

    • getStage

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

    • setStage

      @Stability(Stable) public void setStage(@Nullable String value)
      Describes the current stage for the branch.

    • getTagsRaw

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

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tag for the branch.