Skip to content
v2.275.0

AWS Amplify Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as amplify from 'aws-cdk-lib/aws-amplify';
python
import aws_cdk.aws_amplify as amplify
java
import software.amazon.awscdk.services.amplify.*;
csharp
using Amazon.CDK.AWS.Amplify;
go
import amplify "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:

<span class="package-reference">@aws-cdk/aws-amplify-alpha</span>

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Amplify.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnAppConstruct (L1)The AWS::Amplify::App resource specifies Apps in Amplify Hosting.
CfnBranchConstruct (L1)The AWS::Amplify::Branch resource specifies a new branch within an app.
CfnDomainConstruct (L1)Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.
CfnWebhookConstruct (L1)Resource Type definition for AWS::Amplify::Webhook.
CfnApp.AutoBranchCreationConfigPropertyStructUse the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
CfnApp.BasicAuthConfigPropertyStructUse the BasicAuthConfig property type to set password protection at an app level to all your branches.
CfnApp.CacheConfigPropertyStructDescribes the cache configuration for an Amplify app.
CfnApp.CustomRulePropertyStructThe CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
CfnApp.EnvironmentVariablePropertyStructEnvironment variables are key-value pairs that are available at build time.
CfnApp.JobConfigPropertyStructDescribes the configuration details that apply to the jobs for an Amplify app.
CfnAppPropsStructProperties for defining a CfnApp.
CfnBranch.BackendPropertyStructDescribes the backend associated with an Amplify Branch .
CfnBranch.BasicAuthConfigPropertyStructUse the BasicAuthConfig property type to set password protection for a specific branch.
CfnBranch.EnvironmentVariablePropertyStructThe EnvironmentVariable property type sets environment variables for a specific branch.
CfnBranchPropsStructProperties for defining a CfnBranch.
CfnDomain.CertificatePropertyStructDescribes the SSL/TLS certificate for the domain association.
CfnDomain.CertificateSettingsPropertyStructThe type of SSL/TLS certificate to use for your custom domain.
CfnDomain.SubDomainSettingPropertyStructThe SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.
CfnDomainPropsStructProperties for defining a CfnDomain.
CfnWebhookPropsStructProperties for defining a CfnWebhook.