Apache Camel helps you integrate over 300 different systems!

URI Format

aws-secrets-manager://label[?options]

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

URI Options

The AWS Secrets Manager component supports 17 options, which are listed below.

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

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

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):

Name	Description	Default	Type
label	Required Logical name		String

Name

Description

Default

Type

label

Required Logical name

String

Query Parameters (15 parameters):

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

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

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

<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.

Name	Description	Default	Type
camel.component.aws-secrets-manager.access-key	Amazon AWS Access Key		String
camel.component.aws-secrets-manager.autowired-enabled	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
camel.component.aws-secrets-manager.binary-payload	Set if the secret is binary or not	false	Boolean
camel.component.aws-secrets-manager.configuration	Component configuration. The option is a org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration type.		SecretsManagerConfiguration
camel.component.aws-secrets-manager.enabled	Whether to enable auto configuration of the aws-secrets-manager component. This is enabled by default.		Boolean
camel.component.aws-secrets-manager.lazy-start-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
camel.component.aws-secrets-manager.operation	The operation to perform		SecretsManagerOperations
camel.component.aws-secrets-manager.override-endpoint	Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option	false	Boolean
camel.component.aws-secrets-manager.pojo-request	If we want to use a POJO request as body or not	false	Boolean
camel.component.aws-secrets-manager.proxy-host	To define a proxy host when instantiating the Secrets Manager client		String
camel.component.aws-secrets-manager.proxy-port	To define a proxy port when instantiating the Secrets Manager client		Integer
camel.component.aws-secrets-manager.proxy-protocol	To define a proxy protocol when instantiating the Secrets Manager client		Protocol
camel.component.aws-secrets-manager.region	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
camel.component.aws-secrets-manager.secret-key	Amazon AWS Secret Key		String
camel.component.aws-secrets-manager.secrets-manager-client	To use a existing configured AWS Secrets Manager as client. The option is a software.amazon.awssdk.services.secretsmanager.SecretsManagerClient type.		SecretsManagerClient
camel.component.aws-secrets-manager.trust-all-certificates	If we want to trust all certificates in case of overriding the endpoint	false	Boolean
camel.component.aws-secrets-manager.uri-endpoint-override	Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option		String
camel.component.aws-secrets-manager.use-default-credentials-provider	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

Name

Description

Default

Type

camel.component.aws-secrets-manager.access-key

Amazon AWS Access Key

String

camel.component.aws-secrets-manager.autowired-enabled

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

camel.component.aws-secrets-manager.binary-payload

Set if the secret is binary or not

false

Boolean

camel.component.aws-secrets-manager.configuration

Component configuration. The option is a org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration type.

SecretsManagerConfiguration

camel.component.aws-secrets-manager.enabled

Whether to enable auto configuration of the aws-secrets-manager component. This is enabled by default.

Boolean

camel.component.aws-secrets-manager.lazy-start-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

camel.component.aws-secrets-manager.operation

The operation to perform

SecretsManagerOperations

camel.component.aws-secrets-manager.override-endpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option

false

Boolean

camel.component.aws-secrets-manager.pojo-request

If we want to use a POJO request as body or not

false

Boolean

camel.component.aws-secrets-manager.proxy-host

To define a proxy host when instantiating the Secrets Manager client

String

camel.component.aws-secrets-manager.proxy-port

To define a proxy port when instantiating the Secrets Manager client

Integer

camel.component.aws-secrets-manager.proxy-protocol

To define a proxy protocol when instantiating the Secrets Manager client

Protocol

camel.component.aws-secrets-manager.region

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

camel.component.aws-secrets-manager.secret-key

Amazon AWS Secret Key

String

camel.component.aws-secrets-manager.secrets-manager-client

To use a existing configured AWS Secrets Manager as client. The option is a software.amazon.awssdk.services.secretsmanager.SecretsManagerClient type.

SecretsManagerClient

camel.component.aws-secrets-manager.trust-all-certificates

If we want to trust all certificates in case of overriding the endpoint

false

Boolean

camel.component.aws-secrets-manager.uri-endpoint-override

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option

String

camel.component.aws-secrets-manager.use-default-credentials-provider

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