[[aws-ecs-component]]
== AWS ECS Component

*Available as of Camel version 3.0*

The ECS component supports create, delete, describe and list
https://aws.amazon.com/it/ecs/[AWS ECS] clusters instances.

Prerequisites

You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon ECS. More information are available at
https://aws.amazon.com/ecs/[Amazon ECS].

### URI Format

[source,java]
-------------------------
aws-ecs://label[?options]
-------------------------

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

### URI Options


// component options: START
The AWS ECS component supports 5 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *configuration* (advanced) | The AWS KMS default configuration |  | ECSConfiguration
| *accessKey* (producer) | Amazon AWS Access Key |  | String
| *secretKey* (producer) | Amazon AWS Secret Key |  | String
| *region* (producer) | The region in which KMS client needs to work |  | 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
|===
// component options: END




// endpoint options: START
The AWS ECS endpoint is configured using URI syntax:

----
aws-ecs:label
----

with the following path and query parameters:

==== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *label* | *Required* Logical name |  | String
|===


==== Query Parameters (8 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *accessKey* (producer) | Amazon AWS Access Key |  | String
| *ecsClient* (producer) | To use a existing configured AWS ECS as client |  | AmazonECS
| *operation* (producer) | *Required* The operation to perform |  | ECSOperations
| *proxyHost* (producer) | To define a proxy host when instantiating the ECS client |  | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client |  | Integer
| *region* (producer) | The region in which ECS 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
|===
// endpoint options: END
// spring-boot-auto-configure options: START
=== Spring Boot Auto-Configuration


The component supports 12 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.aws-ecs.access-key* | Amazon AWS Access Key |  | String
| *camel.component.aws-ecs.configuration.access-key* | Amazon AWS Access Key |  | String
| *camel.component.aws-ecs.configuration.ecs-client* | To use a existing configured AWS ECS as client |  | AmazonECS
| *camel.component.aws-ecs.configuration.operation* | The operation to perform |  | ECSOperations
| *camel.component.aws-ecs.configuration.proxy-host* | To define a proxy host when instantiating the ECS client |  | String
| *camel.component.aws-ecs.configuration.proxy-port* | To define a proxy port when instantiating the ECS client |  | Integer
| *camel.component.aws-ecs.configuration.region* | The region in which ECS client needs to work |  | String
| *camel.component.aws-ecs.configuration.secret-key* | Amazon AWS Secret Key |  | String
| *camel.component.aws-ecs.enabled* | Whether to enable auto configuration of the aws-ecs component. This is enabled by default. |  | Boolean
| *camel.component.aws-ecs.region* | The region in which KMS client needs to work |  | String
| *camel.component.aws-ecs.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
| *camel.component.aws-ecs.secret-key* | Amazon AWS Secret Key |  | String
|===
// spring-boot-auto-configure options: END




Required ECS component options

You have to provide the amazonECSClient in the
Registry or your accessKey and secretKey to access
the https://aws.amazon.com/ecs/[Amazon ECS] service.

### Usage

#### Message headers evaluated by the ECS producer

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Header |Type |Description

|`CamelAwsECSMaxResults` |`Integer` |The limit number of results while listing clusters

|`CamelAwsECSOperation` |`String` |The operation we want to perform

|`CamelAwsECSClusterName` |`String` |The cluster name
|=======================================================================

#### ECS Producer operations

Camel-AWS EKS component provides the following operation on the producer side:

- listClusters
- createCluster
- describeCluster
- deleteCluster

Dependencies

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

*pom.xml*

[source,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
(3.0.0 or higher).

### See Also

* Configuring Camel
* Component
* Endpoint
* Getting Started

* AWS Component
