class CfnApp (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Amplify.CfnApp`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnApp`
Java	`software.amazon.awscdk.services.amplify.CfnApp`
Python	`aws_cdk.aws_amplify.CfnApp`
TypeScript	`aws-cdk-lib` » `aws_amplify` » `CfnApp`

Implements IConstruct, IDependable, IInspectable, 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 { aws_amplify as amplify } from 'aws-cdk-lib';
const cfnApp = new amplify.CfnApp(this, 'MyCfnApp', {
  name: 'name',

  // the properties below are optional
  accessToken: 'accessToken',
  autoBranchCreationConfig: {
    autoBranchCreationPatterns: ['autoBranchCreationPatterns'],
    basicAuthConfig: {
      enableBasicAuth: false,
      password: 'password',
      username: 'username',
    },
    buildSpec: 'buildSpec',
    enableAutoBranchCreation: false,
    enableAutoBuild: false,
    enablePerformanceMode: false,
    enablePullRequestPreview: false,
    environmentVariables: [{
      name: 'name',
      value: 'value',
    }],
    framework: 'framework',
    pullRequestEnvironmentName: 'pullRequestEnvironmentName',
    stage: 'stage',
  },
  basicAuthConfig: {
    enableBasicAuth: false,
    password: 'password',
    username: 'username',
  },
  buildSpec: 'buildSpec',
  cacheConfig: {
    type: 'type',
  },
  customHeaders: 'customHeaders',
  customRules: [{
    source: 'source',
    target: 'target',

    // the properties below are optional
    condition: 'condition',
    status: 'status',
  }],
  description: 'description',
  enableBranchAutoDeletion: false,
  environmentVariables: [{
    name: 'name',
    value: 'value',
  }],
  iamServiceRole: 'iamServiceRole',
  oauthToken: 'oauthToken',
  platform: 'platform',
  repository: 'repository',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnApp(scope: Construct, id: string, props: CfnAppProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnAppProps — Resource properties.

Construct Props

Name	Type	Description
name	`string`	The name of the Amplify app.
accessToken?	`string`	The personal access token for a GitHub repository for an Amplify app.
autoBranchCreationConfig?	`IResolvable` `\|` `AutoBranchCreationConfigProperty`	Sets the configuration for your automatic branch creation.
basicAuthConfig?	`IResolvable` `\|` `BasicAuthConfigProperty`	The credentials for basic authorization for an Amplify app.
buildSpec?	`string`	The build specification (build spec) for an Amplify app.
cacheConfig?	`IResolvable` `\|` `CacheConfigProperty`	The cache configuration for the Amplify app.
customHeaders?	`string`	The custom HTTP headers for an Amplify app.
customRules?	`IResolvable` `\|` `IResolvable` `\|` `CustomRuleProperty[]`	The custom rewrite and redirect rules for an Amplify app.
description?	`string`	The description of the Amplify app.
enableBranchAutoDeletion?	`boolean \|` `IResolvable`	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables?	`IResolvable` `\|` `IResolvable` `\|` `EnvironmentVariableProperty[]`	The environment variables for the Amplify app.
iamServiceRole?	`string`	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
oauthToken?	`string`	The OAuth token for a third-party source control system for an Amplify app.
platform?	`string`	The platform for the Amplify app.
repository?	`string`	The Git repository for the Amplify app.
tags?	`CfnTag[]`	The tag for an Amplify app.

name

Type: string

The name of the Amplify app.

accessToken?

Type: string (optional)

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

The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

You must specify either AccessToken or OauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

autoBranchCreationConfig?

Type: IResolvable | AutoBranchCreationConfigProperty (optional)

Sets the configuration for your automatic branch creation.

basicAuthConfig?

Type: IResolvable | BasicAuthConfigProperty (optional)

The credentials for basic authorization for an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

buildSpec?

Type: string (optional)

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

cacheConfig?

Type: IResolvable | CacheConfigProperty (optional)

The cache configuration for the Amplify app.

If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

customHeaders?

Type: string (optional)

The custom HTTP headers for an Amplify app.

customRules?

Type: IResolvable | IResolvable | CustomRuleProperty[] (optional)

The custom rewrite and redirect rules for an Amplify app.

description?

Type: string (optional)

The description of the Amplify app.

enableBranchAutoDeletion?

Type: boolean | IResolvable (optional)

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

environmentVariables?

Type: IResolvable | IResolvable | EnvironmentVariableProperty[] (optional)

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

iamServiceRole?

Type: string (optional)

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

oauthToken?

Type: string (optional)

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

The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .

You must specify either OauthToken or AccessToken when you create a new app.

platform?

Type: string (optional)

The platform for the Amplify app.

For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

repository?

Type: string (optional)

The Git repository for the Amplify app.

tags?

Type: CfnTag[] (optional)

The tag for an Amplify app.

Properties

Name	Type	Description
attrAppId	`string`	Unique Id for the Amplify App.
attrAppName	`string`	Name for the Amplify App.
attrArn	`string`	ARN for the Amplify App.
attrDefaultDomain	`string`	Default domain for the Amplify App.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the Amplify app.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
accessToken?	`string`	The personal access token for a GitHub repository for an Amplify app.
autoBranchCreationConfig?	`IResolvable` `\|` `AutoBranchCreationConfigProperty`	Sets the configuration for your automatic branch creation.
basicAuthConfig?	`IResolvable` `\|` `BasicAuthConfigProperty`	The credentials for basic authorization for an Amplify app.
buildSpec?	`string`	The build specification (build spec) for an Amplify app.
cacheConfig?	`IResolvable` `\|` `CacheConfigProperty`	The cache configuration for the Amplify app.
customHeaders?	`string`	The custom HTTP headers for an Amplify app.
customRules?	`IResolvable` `\|` `IResolvable` `\|` `CustomRuleProperty[]`	The custom rewrite and redirect rules for an Amplify app.
description?	`string`	The description of the Amplify app.
enableBranchAutoDeletion?	`boolean \|` `IResolvable`	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables?	`IResolvable` `\|` `IResolvable` `\|` `EnvironmentVariableProperty[]`	The environment variables for the Amplify app.
iamServiceRole?	`string`	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
oauthToken?	`string`	The OAuth token for a third-party source control system for an Amplify app.
platform?	`string`	The platform for the Amplify app.
repository?	`string`	The Git repository for the Amplify app.
tagsRaw?	`CfnTag[]`	The tag for an Amplify app.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrAppId

Type: string

Unique Id for the Amplify App.

attrAppName

Type: string

Name for the Amplify App.

attrArn

Type: string

ARN for the Amplify App.

attrDefaultDomain

Type: string

Default domain for the Amplify App.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the Amplify app.

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

accessToken?

Type: string (optional)

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

autoBranchCreationConfig?

Type: IResolvable | AutoBranchCreationConfigProperty (optional)

Sets the configuration for your automatic branch creation.

basicAuthConfig?

Type: IResolvable | BasicAuthConfigProperty (optional)

The credentials for basic authorization for an Amplify app.

buildSpec?

Type: string (optional)

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

cacheConfig?

Type: IResolvable | CacheConfigProperty (optional)

The cache configuration for the Amplify app.

customHeaders?

Type: string (optional)

The custom HTTP headers for an Amplify app.

customRules?

Type: IResolvable | IResolvable | CustomRuleProperty[] (optional)

The custom rewrite and redirect rules for an Amplify app.

description?

Type: string (optional)

The description of the Amplify app.

enableBranchAutoDeletion?

Type: boolean | IResolvable (optional)

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

environmentVariables?

Type: IResolvable | IResolvable | EnvironmentVariableProperty[] (optional)

The environment variables for the Amplify app.

iamServiceRole?

Type: string (optional)

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

oauthToken?

Type: string (optional)

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

platform?

Type: string (optional)

The platform for the Amplify app.

repository?

Type: string (optional)

The Git repository for the Amplify app.

tagsRaw?

Type: CfnTag[] (optional)

The tag for an Amplify app.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }