Package software.amazon.awscdk.services.amplify

Class CfnApp

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

All Implemented Interfaces:

IInspectable, IAppRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:03.950Z")
@Stability(Stable)
public class CfnApp
extends CfnResource
implements IInspectable, IAppRef, ITaggable

The AWS::Amplify::App resource specifies Apps in Amplify Hosting.

An App is a collection of branches.

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.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .name("name")
         // the properties below are optional
         .accessToken("accessToken")
         .autoBranchCreationConfig(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())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .buildSpec("buildSpec")
         .cacheConfig(CacheConfigProperty.builder()
                 .type("type")
                 .build())
         .computeRoleArn("computeRoleArn")
         .customHeaders("customHeaders")
         .customRules(List.of(CustomRuleProperty.builder()
                 .source("source")
                 .target("target")
                 // the properties below are optional
                 .condition("condition")
                 .status("status")
                 .build()))
         .description("description")
         .enableBranchAutoDeletion(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .iamServiceRole("iamServiceRole")
         .jobConfig(JobConfigProperty.builder()
                 .buildComputeType("buildComputeType")
                 .build())
         .oauthToken("oauthToken")
         .platform("platform")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnApp.AutoBranchCreationConfigProperty	Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
static interface	CfnApp.BasicAuthConfigProperty	Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
static final class	CfnApp.Builder	A fluent builder for CfnApp.
static interface	CfnApp.CacheConfigProperty	Describes the cache configuration for an Amplify app.
static interface	CfnApp.CustomRuleProperty	The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
static interface	CfnApp.EnvironmentVariableProperty	Environment variables are key-value pairs that are available at build time.
static interface	CfnApp.JobConfigProperty	Describes the configuration details that apply to the jobs for an Amplify app.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.amplify.IAppRef

IAppRef.Jsii$Default, IAppRef.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.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
protected	CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApp(software.amazon.jsii.JsiiObjectRef objRef)
	CfnApp(software.constructs.Construct scope, String id, CfnAppProps props)	Create a new AWS::Amplify::App.

Method Summary

Modifier and Type	Method	Description
static String	arnForApp(IAppRef resource)
String	getAccessToken()	The personal access token for a GitHub repository for an Amplify app.
AppReference	getAppRef()	A reference to a App resource.
String	getAttrAppId()	Unique Id for the Amplify App.
String	getAttrAppName()	Name for the Amplify App.
String	getAttrArn()	ARN for the Amplify App.
String	getAttrDefaultDomain()	Default domain for the Amplify App.
Object	getAutoBranchCreationConfig()	Sets the configuration for your automatic branch creation.
Object	getBasicAuthConfig()	The credentials for basic authorization for an Amplify app.
String	getBuildSpec()	The build specification (build spec) for an Amplify app.
Object	getCacheConfig()	The cache configuration for the Amplify app.
protected Map<String,Object>	getCfnProperties()
String	getComputeRoleArn()	The Amazon Resource Name (ARN) of the IAM role for an SSR app.
String	getCustomHeaders()	The custom HTTP headers for an Amplify app.
Object	getCustomRules()	The custom rewrite and redirect rules for an Amplify app.
String	getDescription()	The description of the Amplify app.
Object	getEnableBranchAutoDeletion()	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
Object	getEnvironmentVariables()	The environment variables for the Amplify app.
String	getIamServiceRole()	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
Object	getJobConfig()	The configuration details that apply to the jobs for an Amplify app.
String	getName()	The name of the Amplify app.
String	getOauthToken()	The OAuth token for a third-party source control system for an Amplify app.
String	getPlatform()	The platform for the Amplify app.
String	getRepository()	The Git repository for the Amplify app.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tag for an Amplify app.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnApp(Object x)	Checks whether the given object is a CfnApp.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessToken(String value)	The personal access token for a GitHub repository for an Amplify app.
void	setAutoBranchCreationConfig(IResolvable value)	Sets the configuration for your automatic branch creation.
void	setAutoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty value)	Sets the configuration for your automatic branch creation.
void	setBasicAuthConfig(IResolvable value)	The credentials for basic authorization for an Amplify app.
void	setBasicAuthConfig(CfnApp.BasicAuthConfigProperty value)	The credentials for basic authorization for an Amplify app.
void	setBuildSpec(String value)	The build specification (build spec) for an Amplify app.
void	setCacheConfig(IResolvable value)	The cache configuration for the Amplify app.
void	setCacheConfig(CfnApp.CacheConfigProperty value)	The cache configuration for the Amplify app.
void	setComputeRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM role for an SSR app.
void	setCustomHeaders(String value)	The custom HTTP headers for an Amplify app.
void	setCustomRules(List<Object> value)	The custom rewrite and redirect rules for an Amplify app.
void	setCustomRules(IResolvable value)	The custom rewrite and redirect rules for an Amplify app.
void	setDescription(String value)	The description of the Amplify app.
void	setEnableBranchAutoDeletion(Boolean value)	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
void	setEnableBranchAutoDeletion(IResolvable value)	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
void	setEnvironmentVariables(List<Object> value)	The environment variables for the Amplify app.
void	setEnvironmentVariables(IResolvable value)	The environment variables for the Amplify app.
void	setIamServiceRole(String value)	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
void	setJobConfig(IResolvable value)	The configuration details that apply to the jobs for an Amplify app.
void	setJobConfig(CfnApp.JobConfigProperty value)	The configuration details that apply to the jobs for an Amplify app.
void	setName(String value)	The name of the Amplify app.
void	setOauthToken(String value)	The OAuth token for a third-party source control system for an Amplify app.
void	setPlatform(String value)	The platform for the Amplify app.
void	setRepository(String value)	The Git repository for the Amplify app.
void	setTagsRaw(List<CfnTag> value)	The tag for an Amplify app.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

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

CfnApp

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

CfnApp

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

CfnApp

@Stability(Stable)
public CfnApp(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAppProps props)

Create a new AWS::Amplify::App.

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

arnForApp

@Stability(Stable)
@NotNull
public static String arnForApp(@NotNull
 IAppRef resource)

Parameters:

resource - This parameter is required.

isCfnApp

@Stability(Stable)
@NotNull
public static Boolean isCfnApp(@NotNull
 Object x)

Checks whether the given object is a CfnApp.

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.

getAppRef

@Stability(Stable)
@NotNull
public AppReference getAppRef()

A reference to a App resource.

Specified by:

getAppRef in interface IAppRef

getAttrAppId

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

Unique Id for the Amplify App.

getAttrAppName

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

Name for the Amplify App.

getAttrArn

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

ARN for the Amplify App.

getAttrDefaultDomain

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

Default domain for the Amplify App.

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

getName

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

The name of the Amplify app.

setName

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

The name of the Amplify app.

getAccessToken

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

The personal access token for a GitHub repository for an Amplify app.

setAccessToken

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

The personal access token for a GitHub repository for an Amplify app.

getAutoBranchCreationConfig

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

Sets the configuration for your automatic branch creation.

Returns union: either IResolvable or CfnApp.AutoBranchCreationConfigProperty

setAutoBranchCreationConfig

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

Sets the configuration for your automatic branch creation.

setAutoBranchCreationConfig

@Stability(Stable)
public void setAutoBranchCreationConfig(@Nullable
 CfnApp.AutoBranchCreationConfigProperty value)

Sets the configuration for your automatic branch creation.

getBasicAuthConfig

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

The credentials for basic authorization for an Amplify app.

Returns union: either IResolvable or CfnApp.BasicAuthConfigProperty

setBasicAuthConfig

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

The credentials for basic authorization for an Amplify app.

setBasicAuthConfig

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

The credentials for basic authorization for an Amplify app.

getBuildSpec

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

The build specification (build spec) for an Amplify app.

setBuildSpec

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

The build specification (build spec) for an Amplify app.

getCacheConfig

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

The cache configuration for the Amplify app.

Returns union: either IResolvable or CfnApp.CacheConfigProperty

setCacheConfig

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

The cache configuration for the Amplify app.

setCacheConfig

@Stability(Stable)
public void setCacheConfig(@Nullable
 CfnApp.CacheConfigProperty value)

The cache configuration for the Amplify app.

getComputeRoleArn

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

The Amazon Resource Name (ARN) of the IAM role for an SSR app.

setComputeRoleArn

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

The Amazon Resource Name (ARN) of the IAM role for an SSR app.

getCustomHeaders

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

The custom HTTP headers for an Amplify app.

setCustomHeaders

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

The custom HTTP headers for an Amplify app.

getCustomRules

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

The custom rewrite and redirect rules for an Amplify app.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApp.CustomRuleProperty>

setCustomRules

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

The custom rewrite and redirect rules for an Amplify app.

setCustomRules

@Stability(Stable)
public void setCustomRules(@Nullable
 List<Object> value)

The custom rewrite and redirect rules for an Amplify app.

getDescription

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

The description of the Amplify app.

setDescription

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

The description of the Amplify app.

getEnableBranchAutoDeletion

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

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Returns union: either Boolean or IResolvable

setEnableBranchAutoDeletion

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

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

setEnableBranchAutoDeletion

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

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

getEnvironmentVariables

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

The environment variables for the Amplify app.

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

setEnvironmentVariables

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

The environment variables for the Amplify app.

setEnvironmentVariables

@Stability(Stable)
public void setEnvironmentVariables(@Nullable
 List<Object> value)

The environment variables for the Amplify app.

getIamServiceRole

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

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

setIamServiceRole

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

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

getJobConfig

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

The configuration details that apply to the jobs for an Amplify app.

Returns union: either IResolvable or CfnApp.JobConfigProperty

setJobConfig

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

The configuration details that apply to the jobs for an Amplify app.

setJobConfig

@Stability(Stable)
public void setJobConfig(@Nullable
 CfnApp.JobConfigProperty value)

The configuration details that apply to the jobs for an Amplify app.

getOauthToken

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

The OAuth token for a third-party source control system for an Amplify app.

setOauthToken

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

The OAuth token for a third-party source control system for an Amplify app.

getPlatform

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

The platform for the Amplify app.

setPlatform

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

The platform for the Amplify app.

getRepository

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

The Git repository for the Amplify app.

setRepository

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

The Git repository for the Amplify app.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tag for an Amplify app.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tag for an Amplify app.