CAMEL-15373 - Create an AWS2-STS component docs
diff --git a/components/camel-aws2-sts/src/main/docs/aws2-ecs-component.adoc b/components/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
similarity index 70%
rename from components/camel-aws2-sts/src/main/docs/aws2-ecs-component.adoc
rename to components/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
index 94aefc9..fdce45c 100644
--- a/components/camel-aws2-sts/src/main/docs/aws2-ecs-component.adoc
+++ b/components/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
@@ -1,9 +1,9 @@
-[[aws2-ecs-component]]
-= AWS 2 Elastic Container Service (ECS) Component
-:docTitle: AWS 2 Elastic Container Service (ECS)
-:artifactId: camel-aws2-ecs
-:description: Manage AWS ECS cluster instances using AWS SDK version 2.x.
-:since: 3.1
+[[aws2-sts-component]]
+= AWS 2 Security Token Service (STS) Component
+:docTitle: AWS 2 Security Token Service (STS)
+:artifactId: camel-aws2-sts
+:description: Manage AWS STS token using AWS SDK version 2.x.
+:since: 3.5
:supportLevel: Stable
:component-header: Only producer is supported
//Manually maintained attributes
@@ -13,25 +13,25 @@
*{component-header}*
-The AWS2 ECS component supports create, delete, describe and list clusters
-https://aws.amazon.com/ecs/[AWS ECS] clusters instances.
+The AWS2 STS component supports assumeRole operation.
+https://aws.amazon.com/sts/[AWS STS].
Prerequisites
You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon ECS. More information is available at
-https://aws.amazon.com/ecs/[Amazon ECS].
+signed up to use Amazon STS. More information is available at
+https://aws.amazon.com/sts/[Amazon STS].
[NOTE]
====
-The AWS2 ECS component is not supported in OSGI
+The AWS2 STS component is not supported in OSGI
====
== URI Format
[source,java]
-------------------------
-aws2-ecs://label[?options]
+aws2-sts://label[?options]
-------------------------
You can append query options to the URI in the following format,
@@ -112,65 +112,26 @@
-Required ECS component options
+Required STS component options
-You have to provide the amazonECSClient in the
+You have to provide the amazonSTSClient in the
Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/ecs/[Amazon ECS] service.
+the https://aws.amazon.com/sts/[Amazon STS] service.
== Usage
-=== Message headers evaluated by the ECS producer
+=== STS Producer operations
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Header |Type |Description
+Camel-AWS STS component provides the following operation on the producer side:
-|`CamelAwsECSMaxResults` |`Integer` |The limit number of results while listing clusters
+- assumeRole
-|`CamelAwsECSOperation` |`String` |The operation we want to perform
+== Automatic detection of StsClient client in registry
-|`CamelAwsECSClusterName` |`String` |The cluster name
-|=======================================================================
-
-=== ECS Producer operations
-
-Camel-AWS ECS component provides the following operation on the producer side:
-
-- listClusters
-- createCluster
-- describeCluster
-- deleteCluster
-
-== Producer Examples
-
-- listClusters: this operation will list the available clusters in ECS
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:listClusters")
- .to("aws2-ecs://test?ecsClient=#amazonEcsClient&operation=listClusters")
---------------------------------------------------------------------------------
-
-== Automatic detection of EcsClient client in registry
-
-The component is capable of detecting the presence of an EcsClient bean into the registry.
+The component is capable of detecting the presence of an StsClient 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 ECS there are multiple operations you can submit, as an example for List cluster request, you can do something like:
-
-------------------------------------------------------------------------------------------------------
-from("direct:start")
- .setBody(ListClustersRequest.builder().maxResults(10).build())
- .to("aws2-ecs://test?ecsClient=#amazonEcsClient&operation=listClusters&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.
@@ -181,11 +142,11 @@
---------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-aws2-ecs</artifactId>
+ <artifactId>camel-aws2-sts</artifactId>
<version>${camel-version}</version>
</dependency>
---------------------------------------
where `$\{camel-version\}` must be replaced by the actual version of Camel.
-include::camel-spring-boot::page$aws2-ecs-starter.adoc[]
+include::camel-spring-boot::page$aws2-sts-starter.adoc[]
