AWS 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.
URI Format
aws2-ec2://label[?options]
You can append query options to the URI in the following format:
?options=value&option2=value&…
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.
For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
You can configure components using:
-
the Component DSL.
-
in a configuration file (
application.properties,*.yamlfiles, etc). -
directly in the Java code.
Configuring Endpoint Options
You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.
A good practice when configuring options is to use Property Placeholders.
Property placeholders provide a few benefits:
-
They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.
-
They allow externalizing the configuration from the code.
-
They help the code to become more flexible and reusable.
The following two sections list all the options, firstly for the component followed by the endpoint.
Component Options
The AWS Elastic Compute Cloud (EC2) component supports 22 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Autowired To use an existing configured AmazonEC2Client client. | Ec2Client | ||
The component configuration. | AWS2EC2Configuration | ||
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 | |
Required The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags. Enum values:
| AWS2EC2Operations | ||
Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean | |
If we want to use a POJO request as body or not. | false | boolean | |
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(). Enum values:
| String | ||
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. | String | ||
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean | |
Used for enabling or disabling all consumer based health checks from this component. | true | boolean | |
Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. | true | boolean | |
To define a proxy host when instantiating the EC2 client. | String | ||
To define a proxy port when instantiating the EC2 client. | Integer | ||
To define a proxy protocol when instantiating the EC2 client. Enum values:
| HTTPS | Protocol | |
Amazon AWS Access Key. | String | ||
If using a profile credentials provider, this parameter will set the profile name. | String | ||
Amazon AWS Secret Key. | String | ||
Amazon AWS Session Token used when the user needs to assume an IAM role. | String | ||
If we want to trust all certificates in case of overriding the endpoint. | false | boolean | |
Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | |
Set whether the EC2 client should expect to load credentials through a profile credentials provider. | false | boolean | |
Set whether the EC2 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EC2. | false | boolean |
Endpoint Options
The AWS Elastic Compute Cloud (EC2) endpoint is configured using URI syntax:
aws2-ec2:label
With the following path and query parameters:
Query Parameters (18 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
Autowired To use an existing configured AmazonEC2Client client. | Ec2Client | ||
Required The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags. Enum values:
| AWS2EC2Operations | ||
Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean | |
If we want to use a POJO request as body or not. | false | boolean | |
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(). Enum values:
| String | ||
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. | String | ||
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 | |
To define a proxy host when instantiating the EC2 client. | String | ||
To define a proxy port when instantiating the EC2 client. | Integer | ||
To define a proxy protocol when instantiating the EC2 client. Enum values:
| HTTPS | Protocol | |
Amazon AWS Access Key. | String | ||
If using a profile credentials provider, this parameter will set the profile name. | String | ||
Amazon AWS Secret Key. | String | ||
Amazon AWS Session Token used when the user needs to assume an IAM role. | String | ||
If we want to trust all certificates in case of overriding the endpoint. | false | boolean | |
Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | |
Set whether the EC2 client should expect to load credentials through a profile credentials provider. | false | boolean | |
Set whether the EC2 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EC2. | 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.
Message Headers
The AWS Elastic Compute Cloud (EC2) component supports 15 message header(s), which is/are listed below:
| Name | Description | Default | Type |
|---|---|---|---|
| Constant: | An image ID of the AWS marketplace. | String | |
CamelAwsEC2InstanceType (producer) Constant: | The instance type we want to create and run. Enum values:
| InstanceType | |
CamelAwsEC2Operation (producer) Constant: | The operation we want to perform. | String | |
CamelAwsEC2InstanceMinCount (producer) Constant: | The minimum number of instances we want to run. | Integer | |
CamelAwsEC2InstanceMaxCount (producer) Constant: | The maximum number of instances we want to run. | Integer | |
CamelAwsEC2InstanceMonitoring (producer) Constant: | Define if we want the running instances to be monitored. | Boolean | |
CamelAwsEC2InstanceKernelId (producer) Constant: | The ID of the kernel. | String | |
CamelAwsEC2InstanceEbsOptimized (producer) Constant: | Define if the creating instance is optimized for EBS I/O. | Boolean | |
CamelAwsEC2InstanceSecurityGroups (producer) Constant: | The security groups to associate to the instances. | Collection | |
CamelAwsEC2InstancesIds (producer) Constant: | A collection of instances IDS to execute start, stop, describe and terminate operations on. | Collection | |
CamelAwsEC2InstancesKeyPair (producer) Constant: | The name of the key pair. | String | |
CamelAwsEC2InstancesClientToken (producer) Constant: | Unique, case-sensitive identifier you provide to ensure the idempotency of the request. | String | |
CamelAwsEC2InstancesPlacement (producer) Constant: | The placement for the instance. | Placement | |
CamelAwsEC2InstancesTags (producer) Constant: | A collection of tags to add or remove from EC2 resources. | Collection | |
CamelAwsEC2SubnetId (producer) Constant: | The ID of the subnet to launch the instance into. | String |
Usage
Static credentials, Default Credential Provider and Profile Credentials Provider
You have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.
The order of evaluation for Default Credentials Provider is the following:
-
Java system properties -
aws.accessKeyIdandaws.secretKey. -
Environment variables -
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEY. -
Web Identity Token from AWS STS.
-
The shared credentials and config files.
-
Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable
AWS_CONTAINER_CREDENTIALS_RELATIVE_URIis set. -
Amazon EC2 Instance profile credentials.
You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.
Only one of static, default and profile credentials could be used at the same time.
For more information about this you can look at AWS credentials documentation
Examples
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");-
startInstances: this operation will start a list of EC2 instances
from("direct:start")
.process(new Processor() {
@Override
public void process(Exchange exchange) throws Exception {
Collection<String> l = new ArrayList<>();
l.add("myinstance");
exchange.getIn().setHeader(AWS2EC2Constants.INSTANCES_IDS, l);
}
})
.to("aws2-ec2://TestDomain?accessKey=xxxx&secretKey=xxxx&operation=startInstances");-
stopInstances: this operation will stop a list of EC2 instances
from("direct:stop")
.process(new Processor() {
@Override
public void process(Exchange exchange) throws Exception {
Collection<String> l = new ArrayList<>();
l.add("myinstance");
exchange.getIn().setHeader(AWS2EC2Constants.INSTANCES_IDS, l);
}
})
.to("aws2-ec2://TestDomain?accessKey=xxxx&secretKey=xxxx&operation=stopInstances");-
terminateInstances: this operation will terminate a list of EC2 instances
from("direct:stop")
.process(new Processor() {
@Override
public void process(Exchange exchange) throws Exception {
Collection<String> l = new ArrayList<>();
l.add("myinstance");
exchange.getIn().setHeader(AWS2EC2Constants.INSTANCES_IDS, l);
}
})
.to("aws2-ec2://TestDomain?accessKey=xxxx&secretKey=xxxx&operation=terminateInstances");Using a POJO as body
Sometimes building an AWS Request can be complex because of multiple options. We introduce the possibility to use a POJO as a 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 23 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Amazon AWS Access Key. | String | ||
To use an existing configured AmazonEC2Client client. The option is a software.amazon.awssdk.services.ec2.Ec2Client type. | Ec2Client | ||
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean | |
The component configuration. The option is a org.apache.camel.component.aws2.ec2.AWS2EC2Configuration type. | AWS2EC2Configuration | ||
Whether to enable auto configuration of the aws2-ec2 component. This is enabled by default. | Boolean | ||
Used for enabling or disabling all consumer based health checks from this component. | true | Boolean | |
Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. | true | Boolean | |
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 | |
The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags. | AWS2EC2Operations | ||
Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | Boolean | |
If we want to use a POJO request as body or not. | false | Boolean | |
If using a profile credentials provider, this parameter will set the profile name. | String | ||
To define a proxy host when instantiating the EC2 client. | String | ||
To define a proxy port when instantiating the EC2 client. | Integer | ||
To define a proxy protocol when instantiating the EC2 client. | https | Protocol | |
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 | ||
Amazon AWS Secret Key. | String | ||
Amazon AWS Session Token used when the user needs to assume an IAM role. | String | ||
If we want to trust all certificates in case of overriding the endpoint. | false | Boolean | |
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. | String | ||
Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | Boolean | |
Set whether the EC2 client should expect to load credentials through a profile credentials provider. | false | Boolean | |
Set whether the EC2 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in EC2. | false | Boolean |