Files
o3de/Gems/AWSClientAuth/cdk/README.md
T
2021-03-25 13:57:57 -07:00

63 lines
1.8 KiB
Markdown

# Welcome to AWSClientAuth CDK Python project!
## Install prerequisites for CDK
https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_prerequisites
## Install cdk
https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_install
The `cdk.json` file tells the CDK Toolkit how to execute your app.
Run from cdk directory within gem.
Optional set up python path to LY Python
```
set PATH="..\..\..\python\runtime\python-3.7.10-rev1-windows\python\";%PATH%
```
This project is set up like a standard Python project. Use python interpreter from Open3d to setup python dependencies
Once the python and pip are set up, you can install the required dependencies.
```
# Run from cdk folder in AWSClientAuth gem
..\..\..\python\pip.cmd install -r requirements.txt
```
Set variables
```
set O3D_AWS_DEPLOY_REGION="us-west-2"
set O3D_AWS_DEPLOY_ACCOUNT=""
set O3D_AWS_PROJECT_NAME="AWSIProject"
If you want to add 3rd party providers fill values in utils/constant.py
```
List stacks
```
cdk ls
```
At this point you can now synthesize the CloudFormation template for this code.
```
cdk synth <stackname>
```
Deploy stacks. Note passed parameters. Deploy will throw error for non-optional parameters.
```
cdk deploy <stackname> --profile <profile-name>
```
To add additional dependencies, for example other CDK libraries, just add
them to your requirements.txt file and rerun the `..\..\..\Lumberyard\python\pip.cmd install -r .\Gems\AWSClientAuth\cdk\requirements.txt`
command.
## Useful commands
* `cdk ls` list all stacks in the app
* `cdk synth` emits the synthesized CloudFormation template
* `cdk deploy` deploy this stack to your default AWS account/region
* `cdk diff` compare deployed stack with current state
* `cdk docs` open CDK documentation
Enjoy!