Skip to content

awsluja/amplify-cli-export-construct

 
 

Repository files navigation

Amplify CLI cdk-exported-backend

Integration Tests

This CDK construct is used to include the CloudFormation resources generated by Amplify CLI Export command. The construct handles assets and CloudFormation files. It offers abstractions over the Amplify CLI generated cloud resources.

The library is published under the following

Language Repository
Typescript/Javascript @aws-amplify/cdk-exported-backend
Python aws-amplify.cdk.exported-backend
Java com.amplifyframework:exported-backend

Usage

Install via NPM:

npm i @aws-amplify/cdk-exported-backend@latest

Add to your CDK app:

import { AmplifyExportedBackend }  from '@aws-amplify/cdk-exported-backend';
...
const amplifyExport = new AmplifyExportedBackend(app, 'AmplifyExportedBackend', {
  path: './amplify-export-myAmplifyApp',
  amplifyEnvironment: 'dev', 
});

Construct Props

The construct props extend stack props and can be used to override the root stack properties.

Name Type Description Required Default
path String You can use the absolute or the relative path to the location of the folder. When using relative paths it's important to note that the path is relative to the root of your CDK application Yes undefined
stage String This works similar to Amplify CLI's environment names. The construct makes modification to be able to integrate into the CDK app. Yes undefined

Deploy this to your account

cdk deploy 

Contributing

We welcome community contributions and pull requests.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.7%
  • JavaScript 8.6%
  • Shell 0.7%