Chapter 23. AWS EC2 Component

Available as of Camel version 2.16

The EC2 component supports create, run, start, stop and terminate AWS EC2 instances.

Prerequisites

You must have a valid Amazon Web Services developer account, and be signed up to use Amazon EC2. More information are available at Amazon EC2.

23.1. URI Format

aws-ec2://label[?options]

You can append query options to the URI in the following format, ?options=value&option2=value&…​

23.2. URI Options

The AWS EC2 component supports 5 options which are listed below.

NameDescriptionDefaultType

configuration (advanced)

The AWS EC2 default configuration

 

EC2Configuration

region (producer)

The region in which EC2 client needs to work

 

String

accessKey (producer)

Amazon AWS Access Key

 

String

secretKey (producer)

Amazon AWS Secret Key

 

String

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The AWS EC2 endpoint is configured using URI syntax:

aws-ec2:label

with the following path and query parameters:

23.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

label

Required Logical name

 

String

23.2.2. Query Parameters (8 parameters):

NameDescriptionDefaultType

accessKey (producer)

Amazon AWS Access Key

 

String

amazonEc2Client (producer)

To use a existing configured AmazonEC2Client as client

 

AmazonEC2Client

operation (producer)

Required The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags

 

EC2Operations

proxyHost (producer)

To define a proxy host when instantiating the EC2 client

 

String

proxyPort (producer)

To define a proxy port when instantiating the EC2 client

 

Integer

region (producer)

The region in which EC2 client needs to work

 

String

secretKey (producer)

Amazon AWS Secret Key

 

String

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

Required EC2 component options

You have to provide the amazonEc2Client in the Registry or your accessKey and secretKey to access the Amazon EC2 service.

23.3. Usage

23.3.1. Message headers evaluated by the EC2 producer

HeaderTypeDescription

CamelAwsEC2ImageId

String

An image ID of the AWS marketplace

CamelAwsEC2InstanceType

com.amazonaws.services.ec2.model.InstanceType

The instance type we want to create and run

CamelAwsEC2Operation

String

The operation we want to perform

CamelAwsEC2InstanceMinCount

Int

The mininum number of instances we want to run.

CamelAwsEC2InstanceMaxCount

Int

The maximum number of instances we want to run.

CamelAwsEC2InstanceMonitoring

Boolean

Define if we want the running instances to be monitored

CamelAwsEC2InstanceEbsOptimized

Boolean

Define if the creating instance is optimized for EBS I/O.

CamelAwsEC2InstanceSecurityGroups

Collection

The security groups to associate to the instances

CamelAwsEC2InstancesIds

Collection

A collection of instances IDS to execute start, stop, describe and terminate operations on.

CamelAwsEC2InstancesTags

Collection

A collection of tags to add or remove from EC2 resources

Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws</artifactId>
    <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel (2.16 or higher).

23.4. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • AWS Component