In order to work with blueprints, you must first install the prerequisites (below) to start synthesizing and testing templates on your local machine.
The following items must be installed prior to working with the blueprints in this repository.
- In the shared CDK folder, run
npm update. - In the CDK folder of your blueprint, run
npm update.
For example, let's say you want to deploy the MSK Serverless -> Studio blueprint. Here are the steps you would follow:
Navigate to shared CDK folder (from root of this repo)
> cd cdk-infra/shared
> npm update
up to date, audited 457 packages in 12s
30 packages are looking for funding
run `npm fund` for details
found 0 vulnerabilities
Navigate to your blueprint folder (from root of this repo)
> cd apps/java-datastream/msk-serverless-to-s3-datastream-java
> npm install
...
> npm update
up to date, audited 457 packages in 12s
30 packages are looking for funding
run `npm fund` for details
found 0 vulnerabilities
Now, you're ready to deploy blueprints.
NOTE: If npm update doesn't actually update your dependency versions, you might have to run npm check update or ncu and manually update the dependency versions in the package.json files in each of the above locations.
- To get started with a blueprint, first ensure you have the necessary prerequisites installed.
- Then clone this repo using the command shown below.
git clone https://github.com/awslabs/managed-service-for-apache-flink-blueprints
- Open a terminal session and navigate to the blueprint of your choice within the project structure; once there, follow the blueprint specific instructions.
- Once you have successfully begun sending data through your blueprint, you have successfully launched and tested a blueprint!
- You can now take the blueprints in this repo, copy them to your own project structure and begin to modify them for your specific needs.