Skip navigation links

Package software.amazon.awscdk.services.amplify

AWS Amplify Construct Library

See: Description

Package software.amazon.awscdk.services.amplify Description

AWS Amplify Construct Library

---

cfn-resources: Stable

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


The AWS Amplify Console provides a Git-based workflow for deploying and hosting fullstack serverless web applications. A fullstack serverless app consists of a backend built with cloud resources such as GraphQL or REST APIs, file and data storage, and a frontend built with single page application frameworks such as React, Angular, Vue, or Gatsby.

Setting up an app with branches, custom rules and a domain

To set up an Amplify Console app, define an App:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.amplify.*;
 import software.amazon.awscdk.core.*;
 
 App amplifyApp = App.Builder.create(this, "MyApp")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(SecretValue.secretsManager("my-github-token"))
                 .build())
         .buildSpec(BuildSpec.fromObjectToYaml(Map.of( // Alternatively add a `amplify.yml` to the repo
                 "version", "1.0",
                 "frontend", Map.of(
                         "phases", Map.of(
                                 "preBuild", Map.of(
                                         "commands", List.of("yarn")),
                                 "build", Map.of(
                                         "commands", List.of("yarn build"))),
                         "artifacts", Map.of(
                                 "baseDirectory", "public",
                                 "files", -"**/*")))))
         .build();
 

To connect your App to GitLab, use the GitLabSourceCodeProvider:

 // Example automatically generated from non-compiling source. May contain errors.
 Object amplifyApp = App.Builder.create(this, "MyApp")
         .sourceCodeProvider(GitLabSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(cdk.SecretValue.secretsManager("my-gitlab-token"))
                 .build())
         .build();
 

To connect your App to CodeCommit, use the CodeCommitSourceCodeProvider:

 // Example automatically generated from non-compiling source. May contain errors.
 Object repository = Repository.Builder.create(this, "Repo")
         .repositoryName("my-repo")
         .build();
 
 Object amplifyApp = App.Builder.create(this, "App")
         .sourceCodeProvider(CodeCommitSourceCodeProvider.Builder.create().repository(repository).build())
         .build();
 

The IAM role associated with the App will automatically be granted the permission to pull the CodeCommit repository.

Add branches:

 // Example automatically generated from non-compiling source. May contain errors.
 Object master = amplifyApp.addBranch("master"); // `id` will be used as repo branch name
 Object dev = amplifyApp.addBranch("dev");
 dev.addEnvironment("STAGE", "dev");
 

Auto build and pull request preview are enabled by default.

Add custom rules for redirection:

 // Example automatically generated from non-compiling source. May contain errors.
 amplifyApp.addCustomRule(Map.of(
         "source", "/docs/specific-filename.html",
         "target", "/documents/different-filename.html",
         "status", amplify.getRedirectStatus().getTEMPORARY_REDIRECT()));
 

When working with a single page application (SPA), use the CustomRule.SINGLE_PAGE_APPLICATION_REDIRECT to set up a 200 rewrite for all files to index.html except for the following file extensions: css, gif, ico, jpg, js, png, txt, svg, woff, ttf, map, json, webmanifest.

 // Example automatically generated from non-compiling source. May contain errors.
 mySinglePageApp.addCustomRule(amplify.getCustomRule().getSINGLE_PAGE_APPLICATION_REDIRECT());
 

Add a domain and map sub domains to branches:

 // Example automatically generated from non-compiling source. May contain errors.
 Object domain = amplifyApp.addDomain("example.com", Map.of(
         "enableAutoSubdomain", true,  // in case subdomains should be auto registered for branches
         "autoSubdomainCreationPatterns", List.of("*", "pr*")));
 domain.mapRoot(master); // map master branch to domain root
 domain.mapSubDomain(master, "www");
 domain.mapSubDomain(dev);
 

Restricting access

Password protect the app with basic auth by specifying the basicAuth prop.

Use BasicAuth.fromCredentials when referencing an existing secret:

 // Example automatically generated from non-compiling source. May contain errors.
 Object amplifyApp = App.Builder.create(this, "MyApp")
         .repository("https://github.com/<user>/<repo>")
         .oauthToken(cdk.SecretValue.secretsManager("my-github-token"))
         .basicAuth(amplify.BasicAuth.fromCredentials("username", cdk.SecretValue.secretsManager("my-github-token")))
         .build();
 

Use BasicAuth.fromGeneratedPassword to generate a password in Secrets Manager:

 // Example automatically generated from non-compiling source. May contain errors.
 Object amplifyApp = App.Builder.create(this, "MyApp")
         .repository("https://github.com/<user>/<repo>")
         .oauthToken(cdk.SecretValue.secretsManager("my-github-token"))
         .basicAuth(amplify.BasicAuth.fromGeneratedPassword("username"))
         .build();
 

Basic auth can be added to specific branches:

 // Example automatically generated from non-compiling source. May contain errors.
 app.addBranch("feature/next", Map.of(
         "basicAuth", amplify.BasicAuth.fromGeneratedPassword("username")));
 

Automatically creating and deleting branches

Use the autoBranchCreation and autoBranchDeletion props to control creation/deletion of branches:

 // Example automatically generated from non-compiling source. May contain errors.
 Object amplifyApp = App.Builder.create(this, "MyApp")
         .repository("https://github.com/<user>/<repo>")
         .oauthToken(cdk.SecretValue.secretsManager("my-github-token"))
         .autoBranchCreation(Map.of( // Automatically connect branches that match a pattern set
                 "patterns", List.of("feature/*", "test/*")))
         .autoBranchDeletion(true)
         .build();
 

Adding custom response headers

Use the customResponseHeaders prop to configure custom response headers for an Amplify app:

 // Example automatically generated from non-compiling source. May contain errors.
 Object amplifyApp = App.Builder.create(stack, "App")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(cdk.SecretValue.secretsManager("my-github-token"))
                 .build())
         .customResponseHeaders(List.of(Map.of(
                 "pattern", "*.json",
                 "headers", Map.of(
                         "custom-header-name-1", "custom-header-value-1",
                         "custom-header-name-2", "custom-header-value-2")), Map.of(
                 "pattern", "/path/*",
                 "headers", Map.of(
                         "custom-header-name-1", "custom-header-value-2"))))
         .build();
 
Skip navigation links