Package software.amazon.awscdk.services.amplify

Class CfnBranch

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.amplify.CfnBranch

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.113Z")
@Stability(Stable)
public class CfnBranch
extends CfnResource
implements IInspectable

A CloudFormation AWS::Amplify::Branch.

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
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBranch.BasicAuthConfigProperty	Use the BasicAuthConfig property type to set password protection for a specific branch.
static final class	CfnBranch.Builder	A fluent builder for CfnBranch.
static interface	CfnBranch.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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBranch(Construct scope, String id, CfnBranchProps props)	Create a new AWS::Amplify::Branch.
protected	CfnBranch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBranch(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAppId()	The unique ID for an Amplify app.
String	getAttrArn()	ARN for a branch, part of an Amplify App.
String	getAttrBranchName()	Name for a branch, part of an Amplify App.
Object	getBasicAuthConfig()	The basic authorization credentials for a branch of an Amplify app.
String	getBranchName()	The name for the branch.
String	getBuildSpec()	The build specification (build spec) for the branch.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description for the branch that is part of an Amplify app.
Object	getEnableAutoBuild()	Enables auto building for the branch.
Object	getEnablePerformanceMode()	Enables performance mode for the branch.
Object	getEnablePullRequestPreview()	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
Object	getEnvironmentVariables()	The environment variables for the branch.
String	getFramework()	The framework for the branch.
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.
String	getStage()	Describes the current stage for the branch.
TagManager	getTags()	The tag for the branch.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value)	The unique ID for an Amplify app.
void	setBasicAuthConfig(IResolvable value)	The basic authorization credentials for a branch of an Amplify app.
void	setBasicAuthConfig(CfnBranch.BasicAuthConfigProperty value)	The basic authorization credentials for a branch of an Amplify app.
void	setBranchName(String value)	The name for the branch.
void	setBuildSpec(String value)	The build specification (build spec) for the branch.
void	setDescription(String value)	The description for the branch that is part of an Amplify app.
void	setEnableAutoBuild(Boolean value)	Enables auto building for the branch.
void	setEnableAutoBuild(IResolvable value)	Enables auto building for the branch.
void	setEnablePerformanceMode(Boolean value)	Enables performance mode for the branch.
void	setEnablePerformanceMode(IResolvable value)	Enables performance mode for the branch.
void	setEnablePullRequestPreview(Boolean value)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
void	setEnablePullRequestPreview(IResolvable value)	Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.
void	setEnvironmentVariables(List<Object> value)	The environment variables for the branch.
void	setEnvironmentVariables(IResolvable value)	The environment variables for the branch.
void	setFramework(String value)	The framework for the branch.
void	setPullRequestEnvironmentName(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.
void	setStage(String value)	Describes the current stage for the branch.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 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 -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

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.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

The tag for the branch.

getAppId

@Stability(Stable)
@NotNull
public String getAppId()

The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

setAppId

@Stability(Stable)
public void setAppId(@NotNull
 String value)

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
public String getBranchName()

The name for the branch.

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

Pattern: (?s).+

setBranchName

@Stability(Stable)
public void setBranchName(@NotNull
 String value)

The name for the branch.

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

Pattern: (?s).+

getBasicAuthConfig

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

setBasicAuthConfig

@Stability(Stable)
public void setBasicAuthConfig(@Nullable
 IResolvable value)

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 .

setBasicAuthConfig

@Stability(Stable)
public void setBasicAuthConfig(@Nullable
 CfnBranch.BasicAuthConfigProperty value)

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
public String getBuildSpec()

The build specification (build spec) for the branch.

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

Pattern: (?s).+

setBuildSpec

@Stability(Stable)
public void setBuildSpec(@Nullable
 String value)

The build specification (build spec) for the branch.

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

Pattern: (?s).+

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description for the branch that is part of an Amplify app.

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description for the branch that is part of an Amplify app.

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

getEnableAutoBuild

@Stability(Stable)
@Nullable
public Object getEnableAutoBuild()

Enables auto building for the branch.

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.

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.

setEnablePerformanceMode

@Stability(Stable)
public void setEnablePerformanceMode(@Nullable
 Boolean value)

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.

setEnablePerformanceMode

@Stability(Stable)
public void setEnablePerformanceMode(@Nullable
 IResolvable value)

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
public 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 .

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.

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 .

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.

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
public Object getEnvironmentVariables()

The environment variables for the branch.

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.

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).*

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.

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
public String getStage()

Describes the current stage for the branch.

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

setStage

@Stability(Stable)
public void setStage(@Nullable
 String value)

Describes the current stage for the branch.

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