Install on AWS

This guide will perform a complete production-ready installation in your AWS environment using AWS CDK.

caution

This is a complex multi step process, and requires high proficiency with AWS, Node.js, and command line tools.

Medplum strives to make this as easy as possible, but despite our best efforts, it is still challenging.

If you have any questions, please contact us or join our Discord.

tip

If you are new to AWS CDK, we strongly recommend reading Getting started with the AWS CDK.

At a high level, the process of installing Medplum on AWS includes:

1. Prerequisites
   1. Setting up IAM permissions
   2. Setting up an SES account
2. Creating a config repo
   1. Setting up CDK
   2. Setting up Medplum CDK
   3. Running the Medplum init tool
3. Deploying the CDK stack
   1. Boostrapping
   2. Synth
   3. Deploy
4. Deploying the Medplum app
   1. Building the Medplum app with your config
   2. Deploying the Medplum app to AWS

The resulting AWS configuration will look like the following:

Prerequisites

AWS CLI Setup

While not strictly required, it is recommended to setup the AWS Command Line Interface (AWS CLI) and your AWS credential file.

When the AWS CLI and credentials are configured, the Medplum aws init command will be able to automate some tasks.

AWS Account Number

The Medplum aws init command will ask for your AWS Account Number.

If the AWS CLI and credentials are configured, then the tool will automatically identify your AWS Account Number.

If not, you can find your AWS Account Number:

1. Sign in to the AWS Management Console with your user name.
2. In the top navigation bar, choose Support and then choose Support Center.
3. Your AWS account ID (account number) appears below the top navigation bar.

AWS Permissions

You will need permission to access the following AWS services:

Service	Details
Elastic Compute Cloud (EC2)	Create a Virtual Private Cloud (VPC) and related security groups
Elasticache	Create a hosted Redis cluster for caching and task queue
Elastic Load Balancing (ELB)	Create a load balancer for server redundancy and high availability
Identity and Access Management (IAM)	Create service roles for the API server and bot lambdas
CloudFront	Securely deliver content with low latency and high transfer speeds
CloudWatch Logs	Create and manage log groups for server logs
Relational Database Service (RDS)	Create a hosted Postgres Aurora database
Route 53	Create DNS entries for the services
Simple Storage Service (S3)	Host static web content, store and retrieve dynamic user content for file attachments
Secrets Manager	Store encrypted secret configuration details such as database credentials
Systems Manager (SSM)	Store configuration details
Web Application Firewall (WAF)	Protect your web applications or APIs against common web exploits and bots

Setup SES

It is strongly recommended to setup an SES email address with production access, meaning that it can send email to any email recipient. Email is used to verify identities, send login instructions, and handle password reset requests.

Follow the Creating and verifying identities in Amazon SES guide to register an email address for system generated emails.

Choose an environment name

Throughout this document, instructions will refer to an "environment name". This environment name is used in multiple places, for example an environment named demo will result in:

1. As part of config file names (i.e., medplum.demo.config.json)
2. As the base of CloudFormation stack names (i.e., MedplumDemo)
3. AWS Parameter Store keys (i.e., /medplum/demo/...)

If you plan to deploy multiple Medplum clusters, you may want to consider a naming strategy.

For example:

Env Name	Config file name	CloudFormation stack name	Parameter Store prefix
prod	medplum.prod.config.json	MedplumProd	/medplum/prod/...
staging	medplum.staging.config.json	MedplumStaging	/medplum/staging/...
test	medplum.test.config.json	MedplumTest	/medplum/test/...
alice	medplum.alice.config.json	MedplumAlice	/medplum/alice/...
bob	medplum.bob.config.json	MedplumBob	/medplum/bob/...

Medplum configuration files and environment names are quite flexible, but it is always recommended to be consistent and stay organized.

Setup a config repo

Create your config repo

Medplum recommends creating a separate git repository and npm project to manage your CDK infra-as-code. This repository will only contain JSON configuration files.

mkdir my-medplum-cdk-config
cd my-medplum-cdk-config
npm init -y

Medplum recommends pushing this git repository to your source control provider such as GitHub or GitLab.

Add CDK dependencies

If you have not already done so, add the common AWS CDK dependencies. This includes all of the base CDK capabilities and constructs.

npm i aws-cdk-lib cdk constructs

Add Medplum dependencies

Add the Medplum CDK and CLI dependencies. This includes the Medplum CDK construct.

npm i @medplum/cdk @medplum/cli

Add cdk.json

Create a new file called cdk.json with the following contents:

{
  "app": "node node_modules/@medplum/cdk/dist/cjs/index.cjs"
}

Run the init tool

Most AWS resources are automatically created using CDK, but some either cannot or are not recommended. Use the medplum aws init command to setup those resources and build the Medplum CDK config file.

npx medplum aws init

Then follow the prompts.

Upon completion, the tool will:

1. Generate a Medplum CDK config file (i.e., medplum.demo.config.json)
2. Optionally generate an AWS CloudFront signing key
3. Optionally request SSL certificates from AWS Certificate Manager
4. Optionally write server config settings to AWS Parameter Store

Make note of the CDK config file name.

See Config Settings for more details on each of the individual configuration settings.

CDK Bootstrap

Bootstrapping is the process of provisioning resources for the AWS CDK before you can deploy AWS CDK apps into an AWS environment.

Run CDK bootstrap:

npx cdk bootstrap -c config=medplum.demo.config.json

Learn more about bootstrapping: https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html

CDK Synth

The synth step catches logical errors in defining your AWS resources.

Run CDK synth:

npx cdk synth -c config=medplum.demo.config.json

CDK Deploy

When you are ready to actually execute the CDK configuration, use the deploy command.

Run CDK deploy:

npx cdk deploy -c config=medplum.demo.config.json

Note that you may receive warnings about changing security details. This is normal and expected anytime CDK makes changes to VPC, IAM, and other security features.

CDK Diff

If you make changes to the CDK config, you can use the diff command to see how it will change your AWS resources.

Run CDK diff:

npx cdk diff -c config=medplum.demo.config.json

Deploy the app

tip

Historically this step required building from source. You can now deploy the app from prebuilt images.

Use the Medplum CLI to deploy the app:

npx medplum aws deploy-app [env name]

For example:

npx medplum aws deploy-app demo

Advanced

Bot Lambda Layer

Optional: If you intend to use Medplum Bots, you will need an AWS Lambda Layer.

At present, the bot layer must be built from source. See Clone the repo and Run the stack to build from source.

After you successfully build the Medplum project from source, you can use the deploy-bot-layer.sh script to build and deploy the Lambda Layer:

./scripts/deploy-bot-layer.sh

See the Creating and sharing Lambda layers guide to learn more.

Ongoing

Upgrade AWS infrastructure

Use CDK to upgrade the infrastructure.

First run cdk diff to check for changes:

npx cdk diff -c config=medplum.[env name].config.json

Then run cdk deploy to apply changes:

npx cdk deploy -c config=medplum.[env name].config.json

Upgrade the app

Use the Medplum CLI to upgrade the app. This will upgrade your app to the latest version.

npx medplum aws update-app [env name]

For example:

npx medplum aws update-app demo

Upgrade the server

Use the Medplum CLI to upgrade the server. This will upgrade your server to the latest version.

npx medplum aws update-server [env name]

For example:

npx medplum aws update-server demo

Troubleshooting

Cannot assume role

You may receive a warning such as:

current credentials could not be used to assume 'arn:aws:iam::[ACCOUNT_ID]:role/cdk-hnb659fds-file-publishing-role-[ACCOUNT_ID]-us-west-2',
but are for the right account. Proceeding anyway.

First, make sure that the specified role exists in your AWS account. If it does not exist, make sure that you ran the cdk bootstrap command.

Next, make sure that your AWS account has permission to assume the role via sts:AssumeRole. You may need to add an IAM policy to add permission.

{
  "Sid": "assumerole",
  "Effect": "Allow",
  "Action": ["sts:AssumeRole", "iam:PassRole"],
  "Resource": ["arn:aws:iam::*:role/cdk-*"]
}

tip

"IAM Full Access" is not enough! The IAM Full Access policy does not include sts:AssumeRole.

Try verbose mode

All CDK operations support verbose logging by adding the --verbose flag. Verbose logging can often reveal hints about confusing behavior.

npx cdk synth --verbose -c config=medplum.demo.config.json

Related Resources

• Video Overview