You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2021/03/12 15:52:56 UTC
[camel] 05/10: CAMEL-16323 - Create a Camel-AWS-Secret-Manager
component
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6de3ab49291a6136bf12634a84b9392b3d646507
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Mar 12 15:13:57 2021 +0100
CAMEL-16323 - Create a Camel-AWS-Secret-Manager component
---
.../docs/aws-secrets-manager-component.adoc | 28 ++++++++++----------
.../main/docs/aws-secrets-manager-component.adoc | 28 ++++++++++----------
.../ROOT/pages}/aws-secrets-manager-component.adoc | 30 ++++++++++++----------
3 files changed, 44 insertions(+), 42 deletions(-)
diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-secrets-manager-component.adoc
similarity index 86%
copy from components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
copy to catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-secrets-manager-component.adoc
index b2aa384..628da08 100644
--- a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-secrets-manager-component.adoc
@@ -1,12 +1,12 @@
[[aws-secrets-manager-component]]
= AWS Secrets Manager 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
-:supportLevel: Stable
+:docTitle: AWS Secrets Manager
+:artifactId: camel-aws-secrets-manager
+:description: Manage AWS Secrets Manager services using AWS SDK version 2.x.
+:since: 3.9
+:supportLevel: Preview
:component-header: Only producer is supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws2-ecs.adoc[opts=optional]
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-secrets-manager.adoc[opts=optional]
//Manually maintained attributes
:group: AWS 2
@@ -42,23 +42,23 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Elastic Container Service (ECS) component supports 15 options, which are listed below.
+The AWS Secrets Manager component supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *configuration* (producer) | Component configuration | | ECS2Configuration
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
+| *configuration* (producer) | Component configuration | | SecretsManagerConfiguration
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *autowiredEnabled* (advanced) | 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
@@ -71,10 +71,10 @@ The AWS 2 Elastic Container Service (ECS) component supports 15 options, which a
// endpoint options: START
-The AWS 2 Elastic Container Service (ECS) endpoint is configured using URI syntax:
+The AWS Secrets Manager endpoint is configured using URI syntax:
----
-aws2-ecs:label
+aws-secrets-manager://label
----
with the following path and query parameters:
@@ -95,15 +95,15 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *accessKey* (security) | Amazon AWS Access Key | | String
diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc b/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
index b2aa384..628da08 100644
--- a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
+++ b/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
@@ -1,12 +1,12 @@
[[aws-secrets-manager-component]]
= AWS Secrets Manager 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
-:supportLevel: Stable
+:docTitle: AWS Secrets Manager
+:artifactId: camel-aws-secrets-manager
+:description: Manage AWS Secrets Manager services using AWS SDK version 2.x.
+:since: 3.9
+:supportLevel: Preview
:component-header: Only producer is supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws2-ecs.adoc[opts=optional]
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-secrets-manager.adoc[opts=optional]
//Manually maintained attributes
:group: AWS 2
@@ -42,23 +42,23 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Elastic Container Service (ECS) component supports 15 options, which are listed below.
+The AWS Secrets Manager component supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *configuration* (producer) | Component configuration | | ECS2Configuration
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
+| *configuration* (producer) | Component configuration | | SecretsManagerConfiguration
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *autowiredEnabled* (advanced) | 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
@@ -71,10 +71,10 @@ The AWS 2 Elastic Container Service (ECS) component supports 15 options, which a
// endpoint options: START
-The AWS 2 Elastic Container Service (ECS) endpoint is configured using URI syntax:
+The AWS Secrets Manager endpoint is configured using URI syntax:
----
-aws2-ecs:label
+aws-secrets-manager://label
----
with the following path and query parameters:
@@ -95,15 +95,15 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *accessKey* (security) | Amazon AWS Access Key | | String
diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc b/docs/components/modules/ROOT/pages/aws-secrets-manager-component.adoc
similarity index 85%
copy from components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
copy to docs/components/modules/ROOT/pages/aws-secrets-manager-component.adoc
index b2aa384..8d67ba3 100644
--- a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
+++ b/docs/components/modules/ROOT/pages/aws-secrets-manager-component.adoc
@@ -1,12 +1,14 @@
[[aws-secrets-manager-component]]
= AWS Secrets Manager 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
-:supportLevel: Stable
+//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
+:page-source: components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc
+:docTitle: AWS Secrets Manager
+:artifactId: camel-aws-secrets-manager
+:description: Manage AWS Secrets Manager services using AWS SDK version 2.x.
+:since: 3.9
+:supportLevel: Preview
:component-header: Only producer is supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws2-ecs.adoc[opts=optional]
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-secrets-manager.adoc[opts=optional]
//Manually maintained attributes
:group: AWS 2
@@ -42,23 +44,23 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Elastic Container Service (ECS) component supports 15 options, which are listed below.
+The AWS Secrets Manager component supports 15 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *configuration* (producer) | Component configuration | | ECS2Configuration
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
+| *configuration* (producer) | Component configuration | | SecretsManagerConfiguration
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *autowiredEnabled* (advanced) | 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
@@ -71,10 +73,10 @@ The AWS 2 Elastic Container Service (ECS) component supports 15 options, which a
// endpoint options: START
-The AWS 2 Elastic Container Service (ECS) endpoint is configured using URI syntax:
+The AWS Secrets Manager endpoint is configured using URI syntax:
----
-aws2-ecs:label
+aws-secrets-manager://label
----
with the following path and query parameters:
@@ -95,15 +97,15 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *ecsClient* (producer) | *Autowired* To use a existing configured AWS ECS as client | | EcsClient
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 4 enums and the value can be one of: listClusters, describeCluster, createCluster, deleteCluster | | ECS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 1 enums and the value can be one of: listSecrets | | SecretsManagerOperations
| *overrideEndpoint* (producer) | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean
| *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 ECS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the ECS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the ECS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which ECS 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
+| *secretsManagerClient* (producer) | *Autowired* To use a existing configured AWS Secrets Manager as client | | SecretsManagerClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *uriEndpointOverride* (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | | String
| *accessKey* (security) | Amazon AWS Access Key | | String