Package: aws-cdk.aws-amplify
AWS Amplify Construct Library---AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.For more information on how to migrate, see theMigrating to AWS CDK v2guide.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 domainTo set up an Amplify Console app, define anApp:importaws_cdk.aws_codebuildascodebuildamplify_app=amplify.App(self,"MyApp",source_code_provider=amplify.GitHubSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-github-token")),build_spec=codebuild.BuildSpec.from_object_to_yaml({# Alternatively add a `amplify.yml` to the repo"version":"1.0","frontend":{"phases":{"pre_build":{"commands":["yarn"]},"build":{"commands":["yarn build"]}},"artifacts":{"base_directory":"public","files":-"**/*"}}}))To connect yourAppto GitLab, use theGitLabSourceCodeProvider:amplify_app=amplify.App(self,"MyApp",source_code_provider=amplify.GitLabSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-gitlab-token")))To connect yourAppto CodeCommit, use theCodeCommitSourceCodeProvider:importaws_cdk.aws_codecommitascodecommitrepository=codecommit.Repository(self,"Repo",repository_name="my-repo")amplify_app=amplify.App(self,"App",source_code_provider=amplify.CodeCommitSourceCodeProvider(repository=repository))The IAM role associated with theAppwill automatically be granted the permission
to pull the CodeCommit repository.Add branches:# amplify_app: amplify.Appmaster=amplify_app.add_branch("master")# `id` will be used as repo branch namedev=amplify_app.add_branch("dev",performance_mode=True)dev.add_environment("STAGE","dev")Auto build and pull request preview are enabled by default.Add custom rules for redirection:# amplify_app: amplify.Appamplify_app.add_custom_rule({"source":"/docs/specific-filename.html","target":"/documents/different-filename.html","status":amplify.RedirectStatus.TEMPORARY_REDIRECT})When working with a single page application (SPA), use theCustomRule.SINGLE_PAGE_APPLICATION_REDIRECTto set up a 200
rewrite for all files toindex.htmlexcept for the following
file extensions: css, gif, ico, jpg, js, png, txt, svg, woff,
ttf, map, json, webmanifest.# my_single_page_app: amplify.Appmy_single_page_app.add_custom_rule(amplify.CustomRule.SINGLE_PAGE_APPLICATION_REDIRECT)Add a domain and map sub domains to branches:# amplify_app: amplify.App# master: amplify.Branch# dev: amplify.Branchdomain=amplify_app.add_domain("example.com",enable_auto_subdomain=True,# in case subdomains should be auto registered for branchesauto_subdomain_creation_patterns=["*","pr*"])domain.map_root(master)# map master branch to domain rootdomain.map_sub_domain(master,"www")domain.map_sub_domain(dev)Restricting accessPassword protect the app with basic auth by specifying thebasicAuthprop.UseBasicAuth.fromCredentialswhen referencing an existing secret:amplify_app=amplify.App(self,"MyApp",source_code_provider=amplify.GitHubSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-github-token")),basic_auth=amplify.BasicAuth.from_credentials("username",SecretValue.secrets_manager("my-github-token")))UseBasicAuth.fromGeneratedPasswordto generate a password in Secrets Manager:amplify_app=amplify.App(self,"MyApp",source_code_provider=amplify.GitHubSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-github-token")),basic_auth=amplify.BasicAuth.from_generated_password("username"))Basic auth can be added to specific branches:# amplify_app: amplify.Appamplify_app.add_branch("feature/next",basic_auth=amplify.BasicAuth.from_generated_password("username"))Automatically creating and deleting branchesUse theautoBranchCreationandautoBranchDeletionprops to control creation/deletion
of branches:amplify_app=amplify.App(self,"MyApp",source_code_provider=amplify.GitHubSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-github-token")),auto_branch_creation=amplify.AutoBranchCreation(# Automatically connect branches that match a pattern setpatterns=["feature/*","test/*"]),auto_branch_deletion=True)Adding custom response headersUse thecustomResponseHeadersprop to configure custom response headers for an Amplify app:amplify_app=amplify.App(self,"App",source_code_provider=amplify.GitHubSourceCodeProvider(owner="<user>",repository="<repo>",oauth_token=SecretValue.secrets_manager("my-github-token")),custom_response_headers=[amplify.CustomResponseHeader(pattern="*.json",headers={"custom-header-name-1":"custom-header-value-1","custom-header-name-2":"custom-header-value-2"}),amplify.CustomResponseHeader(pattern="/path/*",headers={"custom-header-name-1":"custom-header-value-2"})])Deploying AssetssourceCodeProvideris optional; when this is not specified the Amplify app can be deployed to using.zippackages. Theassetproperty can be used to deploy S3 assets to Amplify as part of the CDK:importaws_cdk.aws_s3_assetsasassets# asset: assets.Asset# amplify_app: amplify.Appbranch=amplify_app.add_branch("dev",asset=asset)