Interface | Description |
---|---|
AppProps |
(experimental) Properties for an App.
|
AutoBranchCreation |
(experimental) Auto branch creation configuration.
|
BasicAuthConfig |
(experimental) A Basic Auth configuration.
|
BasicAuthProps |
(experimental) Properties for a BasicAuth.
|
BranchOptions |
(experimental) Options to add a branch to an application.
|
BranchProps |
(experimental) Properties for a Branch.
|
CfnApp.AutoBranchCreationConfigProperty |
Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
|
CfnApp.BasicAuthConfigProperty |
Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
|
CfnApp.CustomRuleProperty |
The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
|
CfnApp.EnvironmentVariableProperty |
Environment variables are key-value pairs that are available at build time.
|
CfnAppProps |
Properties for defining a `CfnApp`.
|
CfnBranch.BasicAuthConfigProperty |
Use the BasicAuthConfig property type to set password protection for a specific branch.
|
CfnBranch.EnvironmentVariableProperty |
The EnvironmentVariable property type sets environment variables for a specific branch.
|
CfnBranchProps |
Properties for defining a `CfnBranch`.
|
CfnDomain.SubDomainSettingProperty |
The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.
|
CfnDomainProps |
Properties for defining a `CfnDomain`.
|
CodeCommitSourceCodeProviderProps |
(experimental) Properties for a CodeCommit source code provider.
|
CustomResponseHeader |
(experimental) Custom response header of an Amplify App.
|
CustomRuleOptions |
(experimental) Options for a custom rewrite/redirect rule for an Amplify App.
|
DomainOptions |
(experimental) Options to add a domain to an application.
|
DomainProps |
(experimental) Properties for a Domain.
|
GitHubSourceCodeProviderProps |
(experimental) Properties for a GitHub source code provider.
|
GitLabSourceCodeProviderProps |
(experimental) Properties for a GitLab source code provider.
|
IApp |
(experimental) An Amplify Console application.
|
IApp.Jsii$Default |
Internal default implementation for
IApp . |
IBranch |
(experimental) A branch.
|
IBranch.Jsii$Default |
Internal default implementation for
IBranch . |
ISourceCodeProvider |
(experimental) A source code provider.
|
ISourceCodeProvider.Jsii$Default |
Internal default implementation for
ISourceCodeProvider . |
SourceCodeProviderConfig |
(experimental) Configuration for the source code provider.
|
SubDomain |
(experimental) Sub domain settings.
|
Enum | Description |
---|---|
RedirectStatus |
(experimental) The status code for a URL rewrite or redirect rule.
|
---
All classes with the
Cfn
prefix in this module (CFN Resources) are always stable and safe to use.
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.
To set up an Amplify Console app, define an App
:
import software.amazon.awscdk.services.codebuild.*; 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
:
App amplifyApp = App.Builder.create(this, "MyApp") .sourceCodeProvider(GitLabSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-gitlab-token")) .build()) .build();
To connect your App
to CodeCommit, use the CodeCommitSourceCodeProvider
:
import software.amazon.awscdk.services.codecommit.*; Repository repository = Repository.Builder.create(this, "Repo") .repositoryName("my-repo") .build(); App 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:
App amplifyApp; Branch master = amplifyApp.addBranch("master"); // `id` will be used as repo branch name Branch dev = amplifyApp.addBranch("dev", BranchOptions.builder() .performanceMode(true) .build()); dev.addEnvironment("STAGE", "dev");
Auto build and pull request preview are enabled by default.
Add custom rules for redirection:
App amplifyApp; amplifyApp.addCustomRule(Map.of( "source", "/docs/specific-filename.html", "target", "/documents/different-filename.html", "status", RedirectStatus.TEMPORARY_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.
App mySinglePageApp; mySinglePageApp.addCustomRule(CustomRule.SINGLE_PAGE_APPLICATION_REDIRECT);
Add a domain and map sub domains to branches:
App amplifyApp; Branch master; Branch dev; Domain domain = amplifyApp.addDomain("example.com", DomainOptions.builder() .enableAutoSubdomain(true) // in case subdomains should be auto registered for branches .autoSubdomainCreationPatterns(List.of("*", "pr*")) .build()); domain.mapRoot(master); // map master branch to domain root domain.mapSubDomain(master, "www"); domain.mapSubDomain(dev);
Password protect the app with basic auth by specifying the basicAuth
prop.
Use BasicAuth.fromCredentials
when referencing an existing secret:
App amplifyApp = App.Builder.create(this, "MyApp") .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-github-token")) .build()) .basicAuth(BasicAuth.fromCredentials("username", SecretValue.secretsManager("my-github-token"))) .build();
Use BasicAuth.fromGeneratedPassword
to generate a password in Secrets Manager:
App amplifyApp = App.Builder.create(this, "MyApp") .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-github-token")) .build()) .basicAuth(BasicAuth.fromGeneratedPassword("username")) .build();
Basic auth can be added to specific branches:
App amplifyApp; amplifyApp.addBranch("feature/next", BranchOptions.builder() .basicAuth(BasicAuth.fromGeneratedPassword("username")) .build());
Use the autoBranchCreation
and autoBranchDeletion
props to control creation/deletion
of branches:
App amplifyApp = App.Builder.create(this, "MyApp") .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-github-token")) .build()) .autoBranchCreation(AutoBranchCreation.builder() // Automatically connect branches that match a pattern set .patterns(List.of("feature/*", "test/*")).build()) .autoBranchDeletion(true) .build();
Use the customResponseHeaders
prop to configure custom response headers for an Amplify app:
App amplifyApp = App.Builder.create(this, "App") .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-github-token")) .build()) .customResponseHeaders(List.of(CustomResponseHeader.builder() .pattern("*.json") .headers(Map.of( "custom-header-name-1", "custom-header-value-1", "custom-header-name-2", "custom-header-value-2")) .build(), CustomResponseHeader.builder() .pattern("/path/*") .headers(Map.of( "custom-header-name-1", "custom-header-value-2")) .build())) .build();
sourceCodeProvider
is optional; when this is not specified the Amplify app can be deployed to using .zip
packages. The asset
property can be used to deploy S3 assets to Amplify as part of the CDK:
import software.amazon.awscdk.services.s3.assets.*; Asset asset; App amplifyApp; Branch branch = amplifyApp.addBranch("dev", BranchOptions.builder().asset(asset).build());