All Collections
Data Sources
Step-by-Step Guide to running Airbridge CloudFormation Template in AWS
Step-by-Step Guide to running Airbridge CloudFormation Template in AWS
Openbridge Support avatar
Written by Openbridge Support
Updated over a week ago

The following guide will detail setting up your Airbridge environment within Amazon Web Services (AWS) using CloudFormation. Whether you're new to AWS or an experienced user looking to integrate Airbridge into your workflow, this document will walk you through each step, ensuring a seamless setup. Let's dive in and get your Airbridge environment up and running.

Setup Your Airbridge AWS Environment Via CloudFormation

You need an Amazon Web Services (AWS) account to utilize Airbridge.

Create an AWS Account:

If you do not have an AWS account, go here and create one. If you have an account, log in.

Configure an AWS Account:

Log in to your AWS account. Go to the "CloudFormation" service.

Create a CloudFormation Stack.

In the "CloudFormation" service in your AWS account, we will need to create a stack.

  • Select "Template is ready"

  • Specify the template as "Amazon S3 URL"

  • Enter this URL:

  • Select "Next"

Specify Task Details

In this step, there are three items you need to supply.

  1. Enter a stack name. You can use "openbridge-airbridge-cloudformation" or whatever name makes sense for your environment.

  2. Enter a S3 bucket name. This is where your data and configuration files will be stored. We suggest using a prefix like ""airbridge-" in your bucket name. Your bucket name would look like "airbridge-my-unique-name". Please ensure you create a unique S3 bucket name, as bucket names are globally unique across all AWS accounts and regions. Using a name that's already taken by another user will result in an error, and having a distinct name ensures you have a dedicated space for your data without conflicts.

  3. Enter a instance profile name. You can leave the default as is or change it to a name you prefer.

Select Next after you have completed the inputs.

Configure Stack options

You can skip the page. Leave everything default. Select Next

Review openbridge-airbridge-cloudformation

The last step is to complete the configuration and run your stack. At the bottom of the page Select "Submit"

CloudFormation Events

After submission, you will set the workflow automatically and complete several steps. If you see your "stack" with CREATE_COMPLETE as a status, everything is ready!

Copy Your AWS Role ARN

Select "Outputs" and copy the Region and Role ARN and Bucket Name someplace safe on your computer. The ARN will look like this;

  • arn:aws:iam::1234567890:role/openbridge-name-you-entered

  • airbridge-s3-buckname-whatever-you-entered

  • AirbridgeInstanceProfileNameYourEntered

The Profile, RoleArn and Bucket Name is what Openbridge needs to automate configuring the remainder of the Airbridge resources on your account. You can find them in the "Outputs" tab:

Make sure to take note of the Profile, Role ARN, and Bucket Name that was output from the CloudFormation. Your all set!

Next Steps....

With the foundation built, you can quickly automate the setup up your Airbridge data pipeline server. See this doc:

Did this answer your question?