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.
URI Format
aws-ec2://label[?options]
You can append query options to the URI in the following format, ?options=value&option2=value&…
URI Options
The AWS EC2 component has no options.
The AWS EC2 endpoint is configured using URI syntax:
aws-ec2:label
with the following path and query parameters:
Path Parameters (1 parameters):
Name | Description | Default | Type |
---|---|---|---|
label |
Required Logical name |
String |
Query Parameters (8 parameters):
Name | Description | Default | Type |
---|---|---|---|
accessKey (producer) |
Amazon AWS Access Key |
String |
|
amazonEc2Client (producer) |
To use a existing configured AmazonEC2Client as client |
AmazonEC2Client |
|
amazonEc2Endpoint (producer) |
The region with which the AWS-EC2 client wants to work with. |
String |
|
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 SQS client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the SQS client |
Integer |
|
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.
Usage
Message headers evaluated by the EC2 producer
Header | Type | Description |
---|---|---|
|
|
An image ID of the AWS marketplace |
|
com.amazonaws.services.ec2.model.InstanceType |
The instance type we want to create and run |
|
|
The operation we want to perform |
|
|
The mininum number of instances we want to run. |
|
|
The maximum number of instances we want to run. |
|
Boolean |
Define if we want the running instances to be monitored |
|
|
Define if the creating instance is optimized for EBS I/O. |
|
Collection |
The security groups to associate to the instances |
|
|
A collection of instances IDS to execute start, stop, describe and terminate operations on. |
|
|
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).