AWS Secrets Manager

Manage secrets using AWS Secrets Manager.

What’s inside

AWS Secrets Manager component, URI syntax: aws-secrets-manager:label

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-aws-secrets-manager-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 24 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.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.aws-secrets-manager.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	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 overriding the endpoint. This option needs to be used in combination with the 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.profile-credentials-name	If using a profile credentials provider, this parameter will set the profile name		String
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	https	Protocol
camel.component.aws-secrets-manager.region	The region in which a 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 an existing configured AWS Secrets Manager client. The option is a software.amazon.awssdk.services.secretsmanager.SecretsManagerClient type.		SecretsManagerClient
camel.component.aws-secrets-manager.session-token	Amazon AWS Session Token used when the user needs to assume an IAM role		String
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 Secrets Manager client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	false	Boolean
camel.component.aws-secrets-manager.use-profile-credentials-provider	Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider.	false	Boolean
camel.component.aws-secrets-manager.use-session-credentials	Set whether the Secrets Manager client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Secrets Manager.	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.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.aws-secrets-manager.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

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 overriding the endpoint. This option needs to be used in combination with the 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.profile-credentials-name

If using a profile credentials provider, this parameter will set the profile name

String

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

https

Protocol

camel.component.aws-secrets-manager.region

The region in which a 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 an existing configured AWS Secrets Manager client. The option is a software.amazon.awssdk.services.secretsmanager.SecretsManagerClient type.

SecretsManagerClient

camel.component.aws-secrets-manager.session-token

Amazon AWS Session Token used when the user needs to assume an IAM role

String

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 Secrets Manager client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

false

Boolean

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

Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider.

false

Boolean

camel.component.aws-secrets-manager.use-session-credentials

Set whether the Secrets Manager client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Secrets Manager.

false

Boolean