AWS Secrets Manager
Since Camel 3.9
Only producer is supported
The AWS Secrets Manager component supports list secret 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 AWS Secrets Manager.
URI Format
aws-secrets-manager://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
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. 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.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for 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, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The AWS Secrets Manager component supports 17 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Set if the secret is binary or not. |
false |
boolean |
|
Component configuration. |
SecretsManagerConfiguration |
||
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. Enum values:
|
SecretsManagerOperations |
||
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. |
false |
boolean |
|
If we want to use a POJO request as body or not. |
false |
boolean |
|
To define a proxy host when instantiating the Secrets Manager client. |
String |
||
To define a proxy port when instantiating the Secrets Manager client. |
Integer |
||
To define a proxy protocol when instantiating the Secrets Manager client. Enum values:
|
HTTPS |
Protocol |
|
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 |
||
Autowired To use a existing configured AWS Secrets Manager as client. |
SecretsManagerClient |
||
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 Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
false |
boolean |
|
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 |
|
Amazon AWS Access Key. |
String |
||
Amazon AWS Secret Key. |
String |
Endpoint Options
The AWS Secrets Manager endpoint is configured using URI syntax:
aws-secrets-manager:label
with the following path and query parameters:
Query Parameters (15 parameters)
Name | Description | Default | Type |
---|---|---|---|
Set if the secret is binary or not. |
false |
boolean |
|
Required The operation to perform. Enum values:
|
SecretsManagerOperations |
||
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. |
false |
boolean |
|
If we want to use a POJO request as body or not. |
false |
boolean |
|
To define a proxy host when instantiating the Secrets Manager client. |
String |
||
To define a proxy port when instantiating the Secrets Manager client. |
Integer |
||
To define a proxy protocol when instantiating the Secrets Manager client. Enum values:
|
HTTPS |
Protocol |
|
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 |
||
Autowired To use a existing configured AWS Secrets Manager as client. |
SecretsManagerClient |
||
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 Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
false |
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 |
|
Amazon AWS Access Key. |
String |
||
Amazon AWS Secret Key. |
String |
Using AWS Secrets Manager Property Function
To use this function you’ll need to provide credentials to AWS Secrets Manager Service as environment variables:
export $CAMEL_VAULT_AWS_ACCESS_KEY=accessKey
export $CAMEL_VAULT_AWS_SECRET_KEY=secretKey
export $CAMEL_VAULT_AWS_REGION=region
You can also configure the credentials in the application.properties
file such as:
camel.vault.aws.accessKey = accessKey
camel.vault.aws.secretKey = secretKey
camel.vault.aws.region = region
If you want instead to use the AWS default credentials provider, you’ll need to provide the following env variables:
export $CAMEL_VAULT_AWS_USE_DEFAULT_CREDENTIALS_PROVIDER=true
export $CAMEL_VAULT_AWS_REGION=region
You can also configure the credentials in the application.properties
file such as:
camel.vault.aws.defaultCredentialsProvider = true
camel.vault.aws.region = region
At this point you’ll be able to reference a property in the following way:
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{aws:route}}"/>
</route>
</camelContext>
Where route will be the name of the secret stored in the AWS Secrets Manager Service.
You could specify a default value in case the secret is not present on AWS Secret Manager:
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{aws:route:default}}"/>
</route>
</camelContext>
In this case if the secret doesn’t exist, the property will fallback to "default" as value.
Also you are able to get particular field of the secret, if you have for example a secret named database of this form:
{
"username": "admin",
"password": "password123",
"engine": "postgres",
"host": "127.0.0.1",
"port": "3128",
"dbname": "db"
}
You’re able to do get single secret value in your route, like for example:
<camelContext>
<route>
<from uri="direct:start"/>
<log message="Username is {{aws:database/username}}"/>
</route>
</camelContext>
Or re-use the property as part of an endpoint.
You could specify a default value in case the particular field of secret is not present on AWS Secret Manager:
<camelContext>
<route>
<from uri="direct:start"/>
<log message="Username is {{aws:database/username:admin}}"/>
</route>
</camelContext>
In this case if the secret doesn’t exist or the secret exists, but the username field is not part of the secret, the property will fallback to "admin" as value.
There is also the syntax to get a particular version of the secret for both the approach, with field/default value specified or only with secret:
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{aws:route@bf9b4f4b-8e63-43fd-a73c-3e2d3748b451}}"/>
</route>
</camelContext>
This approach will return the RAW route secret with version 'bf9b4f4b-8e63-43fd-a73c-3e2d3748b451'.
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{aws:route:default@bf9b4f4b-8e63-43fd-a73c-3e2d3748b451}}"/>
</route>
</camelContext>
This approach will return the route secret value with version 'bf9b4f4b-8e63-43fd-a73c-3e2d3748b451' or default value in case the secret doesn’t exist or the version doesn’t exist.
<camelContext>
<route>
<from uri="direct:start"/>
<log message="Username is {{aws:database/username:admin@bf9b4f4b-8e63-43fd-a73c-3e2d3748b451}}"/>
</route>
</camelContext>
This approach will return the username field of the database secret with version 'bf9b4f4b-8e63-43fd-a73c-3e2d3748b451' or admin in case the secret doesn’t exist or the version doesn’t exist.
For the moment we are not considering the rotation function, if any will be applied, but it is in the work to be done.
The only requirement is adding the camel-aws-secrets-manager jar to your Camel application.
Automatic Camel context reloading on Secret Refresh
Being able to reload Camel context on a Secret Refresh, could be done by specifying the usual credentials (the same used for AWS Secret Manager Property Function).
With Environment variables:
export $CAMEL_VAULT_AWS_USE_DEFAULT_CREDENTIALS_PROVIDER=accessKey
export $CAMEL_VAULT_AWS_REGION=region
or as plain Camel main properties:
camel.vault.aws.useDefaultCredentialProvider = true
camel.vault.aws.region = region
Or by specifying accessKey/SecretKey and region, instead of using the default credentials provider chain.
To enable the automatic refresh you’ll need additional properties to set:
camel.vault.aws.refreshEnabled=true
camel.vault.aws.refreshPeriod=60000
camel.vault.aws.secrets=Secret
camel.main.context-reload-enabled = true
where camel.vault.aws.refreshEnabled
will enable the automatic context reload, camel.vault.aws.refreshPeriod
is the interval of time between two different checks for update events and camel.vault.aws.secrets
is a regex representing the secrets we want to track for updates.
Note that camel.vault.aws.secrets
is not mandatory: if not specified the task responsible for checking updates events will take into accounts or the properties with an aws:
prefix.
Message Headers
The AWS Secrets Manager component supports 8 message header(s), which is/are listed below:
Name | Description | Default | Type |
---|---|---|---|
CamelAwsSecretsManagerOperation (producer) Constant: |
The operation we want to perform. |
String |
|
CamelAwsSecretsManagerMaxResults (producer) Constant: |
The number of results to include in the response. |
Integer |
|
CamelAwsSecretsManagerSecretName (producer) Constant: |
The name of the secret. |
String |
|
CamelAwsSecretsManagerSecretDescription (producer) Constant: |
The description of the secret. |
String |
|
CamelAwsSecretsManagerSecretId (producer) Constant: |
The ARN or name of the secret. |
String |
|
CamelAwsSecretsManagerLambdaRotationFunctionArn (producer) Constant: |
The ARN of the Lambda rotation function that can rotate the secret. |
String |
|
CamelAwsSecretsManagerSecretVersionId (producer) Constant: |
The unique identifier of the version of the secret. |
String |
|
CamelAwsSecretsManagerSecretReplicationRegions (producer) Constant: |
A comma separated list of Regions in which to replicate the secret. |
String |
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.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.
Spring Boot Auto-Configuration
When using aws-secrets-manager 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-aws-secrets-manager-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 18 options, which are listed below.