Package software.amazon.awscdk.cfnpropertymixins.services.amplify

Class CfnBranchPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.amplify.CfnBranchPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.373Z")
@Stability(Stable)
public class CfnBranchPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.amplify.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnBranchPropsMixin cfnBranchPropsMixin = CfnBranchPropsMixin.Builder.create(CfnBranchMixinProps.builder()
         .appId("appId")
         .backend(BackendProperty.builder()
                 .stackArn("stackArn")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .branchName("branchName")
         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBranchPropsMixin.BackendProperty	Describes the backend associated with an Amplify Branch .
static interface	CfnBranchPropsMixin.BasicAuthConfigProperty	Use the BasicAuthConfig property type to set password protection for a specific branch.
static final class	CfnBranchPropsMixin.Builder	A fluent builder for CfnBranchPropsMixin.
static interface	CfnBranchPropsMixin.EnvironmentVariableProperty	The EnvironmentVariable property type sets environment variables for a specific branch.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBranchPropsMixin(CfnBranchMixinProps props)	Create a mixin to apply properties to AWS::Amplify::Branch.
	CfnBranchPropsMixin(CfnBranchMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Amplify::Branch.
protected	CfnBranchPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBranchPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnBranchMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnBranchPropsMixin

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

CfnBranchPropsMixin

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

CfnBranchPropsMixin

@Stability(Stable)
public CfnBranchPropsMixin(@NotNull
 CfnBranchMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Amplify::Branch.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnBranchPropsMixin

@Stability(Stable)
public CfnBranchPropsMixin(@NotNull
 CfnBranchMixinProps props)

Create a mixin to apply properties to AWS::Amplify::Branch.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnBranchMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()