Skip to main content
Kinetic Community

Amazon EC2 Adapter

Overview

The Amazon EC2 Adapter is an adapter that is installed into Kinetic Bridgehub that allows data from Amazon EC2 to be pulled back using bridging. Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides secure, resizable compute capacity in the cloud. It is designed to make web-scale cloud computing easier for developers.

Installation

Note: Check to ensure that this adapter isn't already installed into your bridgehub as part of the base installation before undertaking the installation tasks.

  • Download the kinetic-bridges-adapter-amazonec2.jar file and it's dependencies here
  • Put all of the downloaded files into the WEB-INF/lib folder for you kinetic-bridgehub installation
  • Restart the tomcat that your kinetic-bridgehub installation is located in

Setup

Configuration Values

Name Description
Access Key Access Key that is generated to allow API requests.
Secret Key Secret Key that is generated to allow API requests.
Region Regional endpoint to make your requests.

Example Configuration

Name Value
Access Key JAAADTUYTMNXBC31ALKSJD334
Secret Key aewrAHJLzvcx432QPIOUWERBruyeqSdf
Region us-east-1

Configuration Details

Getting your Access Key and Secret Key
http://docs.aws.amazon.com/AWSSimple...edentials.html

Structures, Fields, and Queries

The Amazon EC2 Adapter uses Amazon's EC2 REST API to retrieve data and because of this the query structure for the adapter is loosely defined by this query structure. The EC2 API documentation can be found here.

Structures

  • All of the 'Describe' Actions in the EC2 API are available as Structures without the Describe appended to the front.
    • ie. The structure 'Instances' maps to the DescribeInstances action. 'AvailabilityZones' matches to the DescribeAvailabilityZones action.

Fields

  • All the fields returned for each XML object representation (found in the EC2 API docs) should be available in the adapters response.
  • If the fields parameter is left blank in a bridge call, all possible fields for the structure will be returned with the result.
    • This is the easiest way to see what fields are available when using this adapter.
    • ie. A call of ?structure=Instances&fields=&query= will return all EC2 instances along with all the field data available for each instance

Queries

  • Any request parameters available in the corresponding 'Describe' action should be available to be included in the query as is.
    • Some Examples
      • Using the InstanceId.N request parameter, the following is a valid Instance query:
        • InstanceId.1=i-02f0c504c2e835cb1&InstanceId.2=i-03409f8cb6736154e
      • Using the Filter.N request parameter, the following is a valid Instance query to search by availability zone:
        • Filter.1.Name=availability-zone&Filter.1.Value=us-east-1b
  • Any Filter query parameters can also be searched just by simple filterName=filterValue syntax in the bridge query (instead of using Amazon's full Filter.N.Name=filterName&Filter.N.Value.filterValue)
    • For example, the availabiltyZone filter example above could be re-written as:
      • availability-zone=us-east-1b

Pagination and Ordering

Pagination

This adapter does not currently support pagination.

Ordering

This adapter does not currently support ordering records.

Changelog

v2.0.0 (2017-11-14)

  • Updated bridge to handle all Amazon EC2 "Describe" endpoints
  • Updated query language to match the Amazon EC2 API with modifications made to simplify Filter queries

v1.0.2 (2017-11-14)

v1.0.1 (2017-05-17)

  • Bug fixed where adapter threw a parsing error when less than 2 EC2 instances were returned

v1.0.0 (2016-05-09)

  • Initial version