This example creates the infrastructure for a static site, which uses an S3 bucket for storing the content.
The cdk.json
file tells the CDK Toolkit how to execute your app.
This project is set up like a standard Python project. The initialization
process also creates a virtualenv within this project, stored under the .venv
directory. To create the virtualenv it assumes that there is a python3
(or python
for Windows) executable in your path with access to the venv
package. If for any reason the automatic creation of the virtualenv fails,
you can create the virtualenv manually.
To manually create a virtualenv on MacOS and Linux:
$ python3 -m venv .venv
After the init process completes and the virtualenv is created, you can use the following step to activate your virtualenv.
$ source .venv/bin/activate
If you are a Windows platform, you would activate the virtualenv like this:
% .venv\Scripts\activate.bat
Once the virtualenv is activated, you can install the required dependencies.
(.venv) $ pip install -r requirements.txt
Before you deploy this project, you should create an Amazon S3 bucket to store your site contents. The site contents (located in the 'site-contents' sub-directory) are deployed to the bucket.
For example,
(.venv) $ aws s3 sync ./static-contents/ s3://your-s3-bucket-for-static-content/
At this point you can now synthesize the CloudFormation template for this code.
(.venv) $ export CDK_DEFAULT_ACCOUNT=$(aws sts get-caller-identity --query Account --output text) (.venv) $ export CDK_DEFAULT_REGION=$(aws configure get region) (.venv) $ cdk synth \ --parameters S3BucketForStaticContents='your-s3-bucket-for-static-contents'
If you generate a CloudFormation template based on our current CDK app, you would see the plain CloudFormation Parameters section:
Parameters: S3BucketForStaticContents: Type: String Description: s3 bucket that the site contents are deployed to
Use cdk deploy
command to create the stack shown above.
(.venv) cdk deploy \ --parameters S3BucketForStaticContents='your-s3-bucket-for-static-contents'
To add additional dependencies, for example other CDK libraries, just add
them to your setup.py
file and rerun the pip install -r requirements.txt
command.
Delete the CloudFormation stack by running the below command.
(.venv) $ cdk destroy
cdk ls
list all stacks in the appcdk synth
emits the synthesized CloudFormation templatecdk deploy
deploy this stack to your default AWS account/regioncdk diff
compare deployed stack with current statecdk docs
open CDK documentation
- Static Site CDK Typescript example (experimental)
- Restricting access to Amazon S3 content by using an origin access identity (OAI)
Enjoy!