## Amplify CLI cdk-exported-backend


[![Integration Tests](https://github.com/aws-amplify/amplify-cli-export-construct/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/aws-amplify/amplify-cli-export-construct/actions/workflows/integration-test.yml)


This CDK construct is used to include the CloudFormation resources generated by [Amplify CLI Export command](https://docs.amplify.aws/cli/usage/export-to-cdk/). 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](https://www.npmjs.com/package/@aws-amplify/cdk-exported-backend)	|
|Python	| [aws-amplify.cdk.exported-backend](https://pypi.org/project/aws-amplify.cdk.exported-backend/)	|
|Java	| [com.amplifyframework:exported-backend](https://search.maven.org/artifact/com.amplifyframework/exported-backend)	|

### Usage

Install via NPM:


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


Add to your CDK app:


```js
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](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.StackProps.html) 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

```bash
cdk deploy 
```



### Contributing

We welcome community contributions and pull requests.

### Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

### License

This project is licensed under the Apache-2.0 License.