Deploy on AWS using CloudFormation

Steps to Deploy Hyperswitch on AWS

Prerequisites

• git installed on your local machine

• node version 18+

• An AWS user account with admin access (you can create an account here if you do not have one)

Step 1 - [Optional] - Create a new user with admin access

If you do not have a user with admin access, follow these steps:

1. Sign into the AWS Management Console

• Go to https://console.aws.amazon.com/iam/

• In the left-hand menu, click Users

• Click the Add users button

2. Set the username

• User name: hyperswitch

3. Attach Permissions

• Choose Attach policies directly.

• In the search bar, type AdministratorAccess

• Check the box for: 🔐 AdministratorAccess – AWS managed, job function

4. Review and Create

• Confirm the details:

• User name: hyperswitch

• Permissions: AdministratorAccess

• Click on Create user

5. Save Access Credentials

• Click on the newly created user hyperswitch to view its details.

• Navigate to the Security credentials tab.

• Under the Access keys section:

  • Click Create access key

  • Choose Command Line Interface (CLI))

  • Click Next, then Create access key

  • Download the .csv file or securely copy the:

    • Access Key ID

    • Secret Access Key

  

Step 2 - Configure your AWS credentials in your terminal

For this step you would need the following from your AWS account

• Preferred AWS region

• Access key ID

• Secret Access Key

• Session Token (if you MFA set up)

Once you have the keys run the below command

export AWS_DEFAULT_REGION=<Your AWS_REGION> // e.g., export AWS_DEFAULT_REGION=us-east-2
export AWS_ACCESS_KEY_ID=<Your Access_Key_Id> // e.g., export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=<Your Secret_Access_Key> // e.g., export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
export AWS_SESSION_TOKEN="<Your AWS_SESSION_TOKEN>" //optional

Step 3 - Deploy Hyperswitch application

Run the below commands in the same terminal session

git clone https://github.com/juspay/hyperswitch-cdk.git
cd hyperswitch-cdk
bash install.sh

Once the script is run you will have to provide the following as inputs:

1. Create a DB password of your choice (should be more than 8 chars).

2. Provide an Admin API key of your choosing via Hyperswitch Dashboard.

3. If you choose to opt-in for the card vault service, provide a master-key when prompted (command to generate the master-key will be displayed on the terminal; also note down the two custodian keys to start the locker)

   • Provide the Locker DB password of your choice when prompted

After the deployment is completed, use the custodian keys to activate the locker (You can find the cURLs here). The host URL of the locker to run these cURLs will be displayed on terminal.

Output

On successful execution of the script, you will receive the following outputs

Estimated cost of running the above setup

The table below offers an estimated cost for operating the setup generated by the CDK script within your AWS environment. This cost is computed under the following assumptions:

• The system is handling a traffic of 1000 transactions per day

• The number of hours per month for each component is 720 (24*30)

*Avg data written per transaction = 16 kb

**Assuming 3.5k API requests per day with 5 i/o operations each and 18 hours peak time per day

***Assuming 30 GET requests per login. Avg new user would receive 10 mb data per request. For 1000 new logins the data transfer = (10*30*1000*) / 1024 ~ 290 GB

Tear down the AWS Deployment

You'll need to destroy the Hyperswitch CDK Stack. To tear down all AWS resources provisioned by the Hyperswitch CDK stack, run the following command. This ensures the required aws_arn context is passed during the destroy process:

cdk destroy -c aws_arn=$(aws sts get-caller-identity --query Arn --output text)

You’ll be prompted to confirm the deletion. Type y when prompted to proceed.

💡 This command removes all infrastructure created by the CDK, including EKS clusters, VPCs, IAM roles, and other resources.

You can check to see if there is anything running:

aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE UPDATE_COMPLETE

If the CDK Toolkit exist, you can execute this command:

aws cloudformation delete-stack --stack-name CDKToolkit

What you deployed in this tutorial

The following components and services were provisioned as part of a new stack in your AWS account:

The following services are installed in the 2 Nodes across the EKS cluster

Architecture Diagram

Next step:

Explore Further

Once you are done with the test payment, you can explore more about these: