[[aws-secrets-manager-component]]
= AWS Secrets Manager Component
//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: Stable
:component-header: Only producer is supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-secrets-manager.adoc[opts=optional]
//Manually maintained attributes
:group: AWS

*Since Camel {since}*

*{component-header}*

The AWS Secrets Manager component supports list secret
https://aws.amazon.com/secrets-manager/[AWS Secrets Manager] service.

Prerequisites

You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon Secrets Manager. More information is available at
https://aws.amazon.com/secrets-manager/[AWS Secrets Manager].

[NOTE]
====
The AWS Secrets Manager component is not supported in OSGI
====

== URI Format

[source,java]
-------------------------
aws-secrets-manager://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 Secrets Manager component supports 17 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *binaryPayload* (producer) | Set if the secret is binary or not | false | boolean
| *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 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. There are 8 enums and the value can be one of: listSecrets, createSecret, getSecret, describeSecret, deleteSecret, rotateSecret, updateSecret, replicateSecretToRegions |  | 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 Secrets Manager client |  | String
| *proxyPort* (producer) | To define a proxy port when instantiating the Secrets Manager client |  | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Secrets Manager client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which Secrets Manager 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
| *useDefaultCredentialsProvider* (producer) | Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean
| *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
| *accessKey* (security) | Amazon AWS Access Key |  | String
| *secretKey* (security) | Amazon AWS Secret Key |  | String
|===
// component options: END




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

----
aws-secrets-manager://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 (15 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *binaryPayload* (producer) | Set if the secret is binary or not | false | boolean
| *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. There are 8 enums and the value can be one of: listSecrets, createSecret, getSecret, describeSecret, deleteSecret, rotateSecret, updateSecret, replicateSecretToRegions |  | 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 Secrets Manager client |  | String
| *proxyPort* (producer) | To define a proxy port when instantiating the Secrets Manager client |  | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Secrets Manager client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which Secrets Manager 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
| *useDefaultCredentialsProvider* (producer) | Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean
| *accessKey* (security) | Amazon AWS Access Key |  | String
| *secretKey* (security) | Amazon AWS Secret Key |  | String
|===
// endpoint options: END

=== Secrets Manager Producer operations

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

- listSecrets
- createSecret
- deleteSecret
- describeSecret
- rotateSecret
- getSecret
- updateSecret
- replicateSecretToRegions

== 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-secrets-manager</artifactId>
    <version>${camel-version}</version>
</dependency>
---------------------------------------

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

include::{page-component-version}@camel-spring-boot::page$aws-secrets-manager-starter.adoc[]
