AWS EC2 Component

Table of Contents

URI Format
URI Options
Usage
See Also

Available as of Camel 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 component supports 9 endpoint options which are listed below:

{% raw %}

NameGroupDefaultJava TypeDescription

label

producer

 

String

Required Logical name

accessKey

producer

 

String

Amazon AWS Access Key

amazonEc2Client

producer

 

AmazonEC2Client

To use a existing configured AmazonEC2Client as client

amazonEc2Endpoint

producer

 

String

The region with which the AWS-EC2 client wants to work with.

operation

producer

 

EC2Operations

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

proxyHost

producer

 

String

To define a proxy host when instantiating the SQS client

proxyPort

producer

 

Integer

To define a proxy port when instantiating the SQS client

secretKey

producer

 

String

Amazon AWS Secret Key

synchronous

advanced

false

boolean

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

{% endraw %}

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

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).

See Also