AWS 2 Elastic Compute Cloud (EC2)

Since Camel 3.1

Only producer is supported

The AWS2 EC2 component supports the ability to 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 is available at Amazon EC2.

The AWS2 EC2 component is not supported in OSGI

URI Format

aws2-ec2://label[?options]

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

URI Options

The AWS 2 Elastic Compute Cloud (EC2) component supports 12 options, which are listed below.

Name Description Default Type

accessKey (producer)

Amazon AWS Access Key

String

amazonEc2Client (producer)

To use a existing configured AmazonEC2Client as client

Ec2Client

configuration (producer)

The component configuration

AWS2EC2Configuration

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

operation (producer)

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

AWS2EC2Operations

pojoRequest (producer)

If we want to use a POJO request as body or not

false

boolean

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

proxyProtocol (producer)

To define a proxy protocol when instantiating the EC2 client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which EC2 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

secretKey (producer)

Amazon AWS Secret Key

String

basicPropertyBinding (advanced)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

The AWS 2 Elastic Compute Cloud (EC2) endpoint is configured using URI syntax:

aws2-ec2:label

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

label

Required Logical name

String

Query Parameters (12 parameters):

Name Description Default Type

accessKey (producer)

Amazon AWS Access Key

String

amazonEc2Client (producer)

To use a existing configured AmazonEC2Client as client

Ec2Client

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

operation (producer)

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

AWS2EC2Operations

pojoRequest (producer)

If we want to use a POJO request as body or not

false

boolean

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

proxyProtocol (producer)

To define a proxy protocol when instantiating the EC2 client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which EC2 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

secretKey (producer)

Amazon AWS Secret Key

String

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

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

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

Supported producer operations

  • createAndRunInstances

  • startInstances

  • stopInstances

  • terminateInstances

  • describeInstances

  • describeInstancesStatus

  • rebootInstances

  • monitorInstances

  • unmonitorInstances

  • createTags

  • deleteTags

Producer Examples

  • createAndRunInstances: this operation will create an EC2 instance and run it

from("direct:createAndRun")
     .setHeader(EC2Constants.IMAGE_ID, constant("ami-fd65ba94"))
     .setHeader(EC2Constants.INSTANCE_TYPE, constant(InstanceType.T2Micro))
     .setHeader(EC2Constants.INSTANCE_MIN_COUNT, constant("1"))
     .setHeader(EC2Constants.INSTANCE_MAX_COUNT, constant("1"))
     .to("aws2-ec2://TestDomain?accessKey=xxxx&secretKey=xxxx&operation=createAndRunInstances");

Automatic detection of Ec2Client client in registry

The component is capable of detecting the presence of an Ec2Client bean into the registry. If it’s the only instance of that type it will be used as client and you won’t have to define it as uri parameter. This may be really useful for smarter configuration of the endpoint.

Using a POJO as body

Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as body. In AWS EC2 there are multiple operations you can submit, as an example for Create and run an instance, you can do something like:

from("direct:start")
  .setBody(RunInstancesRequest.builder().imageId("test-1").instanceType(InstanceType.T2_MICRO).build())
  .to("aws2-ec2://TestDomain?accessKey=xxxx&secretKey=xxxx&operation=createAndRunInstances&pojoRequest=true");

In this way you’ll pass the request directly without the need of passing headers and options specifically related to this operation.

Dependencies

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

pom.xml

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

where ${camel-version} must be replaced by the actual version of Camel.

Spring Boot Auto-Configuration

When using aws2-ec2 with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-aws2-ec2-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 13 options, which are listed below.

Name Description Default Type

camel.component.aws2-ec2.access-key

Amazon AWS Access Key

String

camel.component.aws2-ec2.amazon-ec2-client

To use a existing configured AmazonEC2Client as client. The option is a software.amazon.awssdk.services.ec2.Ec2Client type.

String

camel.component.aws2-ec2.basic-property-binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.aws2-ec2.configuration

The component configuration. The option is a org.apache.camel.component.aws2.ec2.AWS2EC2Configuration type.

String

camel.component.aws2-ec2.enabled

Whether to enable auto configuration of the aws2-ec2 component. This is enabled by default.

Boolean

camel.component.aws2-ec2.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.aws2-ec2.operation

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

AWS2EC2Operations

camel.component.aws2-ec2.pojo-request

If we want to use a POJO request as body or not

false

Boolean

camel.component.aws2-ec2.proxy-host

To define a proxy host when instantiating the EC2 client

String

camel.component.aws2-ec2.proxy-port

To define a proxy port when instantiating the EC2 client

Integer

camel.component.aws2-ec2.proxy-protocol

To define a proxy protocol when instantiating the EC2 client

Protocol

camel.component.aws2-ec2.region

The region in which EC2 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

camel.component.aws2-ec2.secret-key

Amazon AWS Secret Key

String