class App (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Amplify.App
Java	software.amazon.awscdk.services.amplify.App
Python	aws_cdk.aws_amplify.App
TypeScript (source)	@aws-cdk/aws-amplify » App

Implements IConstruct, IConstruct, IDependable, IResource, IApp, IGrantable

An Amplify Console application.

Example

const amplifyApp = new amplify.App(this, 'MyApp', {
  sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
    owner: '<user>',
    repository: '<repo>',
    oauthToken: SecretValue.secretsManager('my-github-token'),
  }),
  autoBranchCreation: { // Automatically connect branches that match a pattern set
    patterns: ['feature/*', 'test/*'],
  },
  autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository
});

Initializer

new App(scope: Construct, id: string, props: AppProps)

Parameters

• scope Construct
• id string
• props AppProps

Construct Props

Name	Type	Description
appName?🔹	string	The name for the application.
autoBranchCreation?🔹	AutoBranchCreation	The auto branch creation configuration.
autoBranchDeletion?🔹	boolean	Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
basicAuth?🔹	BasicAuth	The Basic Auth configuration.
buildSpec?🔹	BuildSpec	BuildSpec for the application.
customResponseHeaders?🔹	CustomResponseHeader[]	The custom HTTP response headers for an Amplify app.
customRules?🔹	CustomRule[]	Custom rewrite/redirect rules for the application.
description?🔹	string	A description for the application.
environmentVariables?🔹	{ [string]: string }	Environment variables for the application.
role?🔹	IRole	The IAM service role to associate with the application.
sourceCodeProvider?🔹	ISourceCodeProvider	The source code provider for this application.

---

appName?🔹

Type: string (optional, default: a CDK generated name)

The name for the application.

---

autoBranchCreation?🔹

Type: AutoBranchCreation (optional, default: no auto branch creation)

The auto branch creation configuration.

Use this to automatically create branches that match a certain pattern.

---

autoBranchDeletion?🔹

Type: boolean (optional, default: false)

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

---

basicAuth?🔹

Type: BasicAuth (optional, default: no password protection)

The Basic Auth configuration.

Use this to set password protection at an app level to all your branches.

---

buildSpec?🔹

Type: BuildSpec (optional, default: no build spec)

BuildSpec for the application.

Alternatively, add a amplify.yml file to the repository.

See also: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

---

customResponseHeaders?🔹

Type: CustomResponseHeader[] (optional, default: no custom response headers)

The custom HTTP response headers for an Amplify app.

See also: https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html

---

customRules?🔹

Type: CustomRule[] (optional, default: no custom rewrite/redirect rules)

Custom rewrite/redirect rules for the application.

---

description?🔹

Type: string (optional, default: no description)

A description for the application.

---

environmentVariables?🔹

Type: { [string]: string } (optional, default: no environment variables)

Environment variables for the application.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

---

role?🔹

Type: IRole (optional, default: a new role is created)

The IAM service role to associate with the application.

The App implements IGrantable.

---

sourceCodeProvider?🔹

Type: ISourceCodeProvider (optional, default: not connected to a source code provider)

The source code provider for this application.

Properties

Name	Type	Description
appId🔹	string	The application id.
appName🔹	string	The name of the application.
arn🔹	string	The ARN of the application.
defaultDomain🔹	string	The default domain of the application.
env🔹	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal🔹	IPrincipal	The principal to grant permissions to.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.

---

appId🔹

Type: string

The application id.

---

appName🔹

Type: string

The name of the application.

---

arn🔹

Type: string

The ARN of the application.

---

defaultDomain🔹

Type: string

The default domain of the application.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addAutoBranchEnvironment(name, value)🔹	Adds an environment variable to the auto created branch.
addBranch(id, options?)🔹	Adds a branch to this application.
addCustomRule(rule)🔹	Adds a custom rewrite/redirect rule to this application.
addDomain(id, options?)🔹	Adds a domain to this application.
addEnvironment(name, value)🔹	Adds an environment variable to this application.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromAppId(scope, id, appId)🔹	Import an existing application.

---

addAutoBranchEnvironment(name, value)🔹

public addAutoBranchEnvironment(name: string, value: string): App

Parameters

• name string
• value string

Returns

• App

Adds an environment variable to the auto created branch.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

---

addBranch(id, options?)🔹

public addBranch(id: string, options?: BranchOptions): Branch

Parameters

• id string
• options BranchOptions

Returns

• Branch

Adds a branch to this application.

---

addCustomRule(rule)🔹

public addCustomRule(rule: CustomRule): App

Parameters

• rule CustomRule

Returns

• App

Adds a custom rewrite/redirect rule to this application.

---

addDomain(id, options?)🔹

public addDomain(id: string, options?: DomainOptions): Domain

Parameters

• id string
• options DomainOptions

Returns

• Domain

Adds a domain to this application.

---

addEnvironment(name, value)🔹

public addEnvironment(name: string, value: string): App

Parameters

• name string
• value string

Returns

• App

Adds an environment variable to this application.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromAppId(scope, id, appId)🔹

public static fromAppId(scope: Construct, id: string, appId: string): IApp

Parameters

• scope Construct
• id string
• appId string

Returns

• IApp

Import an existing application.