The goal of this article is to guide you through initial steps to launch an Amazon AWS EC2 Instance to run the ERT in Cloud WebSocket Python example from the instance. The instance is based on a Refinitiv Amazon Machine Image (AMI) which included all examples are required libraries for users.
Description In this quick start guide, we will cover the following areas:
- How to launch your EC2 Amazon Linux instance based on Refinitiv's AMI
- How to connect to your EC2 Amazon Linux instance
- How to run ERT in Cloud demo application inside your newly created EC2 Amazon Linux instance
The following accounts and softwares are required in order to run this quick start guide:
- Amazon AWS account
- Web Browser
- Internet connection
- SSH client software or Putty application
- Amazon AWS key pair
- ERT in Cloud Username/machine ID and password access credentials. Please reach out to your Refinitiv sales associate to acquire ERT in Cloud Username/machine ID and password access credentials.
If you are new to Amazon AWS, you can subscribe to AWS Free Tier account which gives you a free hands-on access to AWS platform and services. We highly recommend you follow the Amazon AWS Setting Up with Amazon EC2 and Getting Started with Amazon EC2 Linux Instances tutorials before proceeding futher in this quick start guide to create your key-pair, VPC and Security Group which are required for your EC2 instance.
Firstly, login to AWS Management Console with your IAM user.
Refinitiv AMI is available in US East (N. Virginia), Asia Pacific (Singapore) and EU (Ireland) Regions. This Quick Start page will use "US East (N. Virginia)" Region as a demonstration. Once you are logged in to the AWS Management Console, choose "US East (N. Virginia)" In the Region section.
Go to EC2 Dashboard page, then choose IMAGES -> AMIs section.
In the AMIs page, select "Public images" and then search Refinitiv' AMI name with Refinitiv name filter.
Select Refinitiv AMI, then select "Launch".
Select your Instance type based on your preference and requirement, then click "Review and Launch" button.
You may choose "Configure Instance Details" button to configure Instance network and public IP address (see more detail here), storage, etc based on your requirement. Click "Launch" button to launch your EC2 Linux instance.
Select your key pair which will be used to connect to your instance with your local machine. You can also create a new key-pair for this instance here. Click "Launch Instances" button to launch your Linux instance.
Back to EC2 Dashboard, you will see your newly created Amazon Linux instance is running with the instance information such as Instance ID, Public DNS (IPv4), IPv4 Public IP, etc. The main information is Public DNS (IPv4) which is required to connect to this instance.
Once your Amazon Linux instance is running, you can connect to your Amazon Linux instance using Putty or SSH client applications. The following information are required to connect to your instance.
- Your private key file (example: key-pair.pem)
- Your Linux instance Public DNS
You can find more details regarding how to connect to your Amazon Linux instance from the following AWS documents links below:
- Connecting to Your Linux Instance from Windows Using PuTTY
- Connecting to Your Linux Instance Using SSH
This article uses Git Bash application as a SSH client to connect to Amazon Linux instance with the following command
ssh -i "<your private key file name>" ec2-user@<Your Linux instance Public DNS>
ssh -i "Administrator-key-pair-us-east-1.pem" firstname.lastname@example.org
Once you have connected to your Amazon Linux instance, you will be available in your home folder /home/ec2-user location. Your home folder contains the following example and API folders:
- Elektron-SDK folder: contains the Elektron SDK C++ and Java examples for ERT in Cloud's RSSL connection.
- WebsocketAPI folder: contains the Elektron WebSocket API examples in Python, Java and C# languages for ERT in Cloud's WebSocket connection.
Each sub folder contains README.md file which give you a full description regarding the examples detail and how to run examples.
Please refer to following the series of ERT in Cloud Quick Start based on your prefer API and connection:
- Elektron WebSocket API Quick Start - Connecting to Elektron Real Time in Cloud.
- EMA Java Quick Start - Connecting to Elektron Real Time in Cloud.
- ETA Java Quick Start - Connecting to Elektron Real Time in Cloud.
- EMA C++ Quick Start - Connecting to Elektron Real Time in Cloud
- ETA C++ Quick Start - Connecting to Elektron Real Time in Cloud
Note: This Refinitiv based AMI machined already installed all examples required libraries for users.
Q: How can I have Elektron Data Platform username and password
A: Please contact your Refinitiv's Technical Account Manager or Technical Relationship Manager to help you to access EDP account and services.
Q: I do not have a private key pair file
A: Please follow the steps in AWS Document: Create a Key Pair link to create your private key pair file.
Q: My Amazon EC2 instance does not have a Public DNS IP address
A: The instance Public DNS and IP address need to be configured before launching the instance. Please refer to this AWS Document: Assigning a Public IPv4 Address During Instance Launch link. This public IPv4 address is automatically released in certain cases (stop instance, etc). If you already launched an instance or need a persistance public IP address, you can associate an AWS Elastic IP Address with the instance.
Note: AWS Elastic IP Address is not included in the AWS Free Tier services.
Q: What should I do after I finish running an example application
A: You can "Terminate" instance to delete your E2 instance permanently or "Stop" instance to just shutdown your instance and release all public DNS IP address. Please refer to AWS Document: Clean Up Your Instance link for more detail.
For further details, please check out the following resources:
- Refinitiv Elektron SDK Family page on the Refinitiv Developer Community web site.
- Developer Webinar Recording: Introduction to Enterprise App Creation With Open-Source Elektron Message API
- Refinitiv Elektron Data Platform
- Refinitiv Elektron: RIC Search
- Refinitiv Data Model Discovery page: Explore TR data models, content definitions and data update behaviors
For any question related to this quick start guide or Elektron Real Time in Cloud, please use the Developer Community Q&A Forum.