이 콘텐츠는 선택한 언어로 제공되지 않습니다.
Chapter 12. AWS Secrets Manager
Only producer is supported
The AWS Secrets Manager component supports 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.
12.1. Dependencies 링크 복사링크가 클립보드에 복사되었습니다!
When using camel-aws-secrets-manager with Red Hat build of Camel Spring Boot, add the following Maven dependency to your pom.xml to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-aws-secrets-manager-starter</artifactId> </dependency>
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-aws-secrets-manager-starter</artifactId>
</dependency>
12.2. URI Format 링크 복사링크가 클립보드에 복사되었습니다!
aws-secrets-manager://label[?options]
aws-secrets-manager://label[?options]
You can append query options to the URI in the following format:
`?options=value&option2=value&…`
`?options=value&option2=value&…`
12.3. Configuring Options 링크 복사링크가 클립보드에 복사되었습니다!
Camel components are configured on two separate levels:
- component level
- endpoint level
12.3.1. Configuring Component Options 링크 복사링크가 클립보드에 복사되었습니다!
At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level. 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.
You can configure components using:
- the Component DSL.
- in a configuration file (application.properties, *.yaml files, etc).
- directly in the Java code.
12.3.2. Configuring Endpoint Options 링크 복사링크가 클립보드에 복사되었습니다!
You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or 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.
Property placeholders provide a few benefits:
- They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.
- They allow externalizing the configuration from the code.
- They help the code to become more flexible and reusable.
The following two sections list all the options, firstly for the component followed by the endpoint.
12.4. Component Options 링크 복사링크가 클립보드에 복사되었습니다!
The AWS Secrets Manager component supports 23 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. Enum values:
| SecretsManagerOperations | |
| overrideEndpoint (producer) | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean |
| pojoRequest (producer) | If we want to use a POJO request as body or not. | false | boolean |
| profileCredentialsName (producer) | If using a profile credentials provider, this parameter will set the profile name. | String | |
| region (producer) | 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(). Enum values:
| String | |
| uriEndpointOverride (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. | String | |
| useProfileCredentialsProvider (producer) | Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider. | 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 |
| secretsManagerClient (advanced) | Autowired To use an existing configured AWS Secrets Manager client. | SecretsManagerClient | |
| healthCheckConsumerEnabled (health) | Used for enabling or disabling all consumer based health checks from this component. | true | boolean |
| healthCheckProducerEnabled (health) | 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 |
| proxyHost (proxy) | To define a proxy host when instantiating the Secrets Manager client. | String | |
| proxyPort (proxy) | To define a proxy port when instantiating the Secrets Manager client. | Integer | |
| proxyProtocol (proxy) | To define a proxy protocol when instantiating the Secrets Manager client. Enum values:
| HTTPS | Protocol |
| accessKey (security) | Amazon AWS Access Key. | String | |
| secretKey (security) | Amazon AWS Secret Key. | String | |
| sessionToken (security) | Amazon AWS Session Token used when the user needs to assume an IAM role. | String | |
| trustAllCertificates (security) | If we want to trust all certificates in case of overriding the endpoint. | false | boolean |
| useDefaultCredentialsProvider (security) | 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 |
| useSessionCredentials (security) | 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 |
12.5. Endpoint Options 링크 복사링크가 클립보드에 복사되었습니다!
The AWS Secrets Manager endpoint is configured using URI syntax:
aws-secrets-manager:label
aws-secrets-manager:label
With the following path and query parameters:
12.5.1. Path Parameters (1 parameters) 링크 복사링크가 클립보드에 복사되었습니다!
| Name | Description | Default | Type |
|---|---|---|---|
| label (producer) | Required Logical name. | String |
12.5.2. Query Parameters (19 parameters) 링크 복사링크가 클립보드에 복사되었습니다!
| Name | Description | Default | Type |
|---|---|---|---|
| binaryPayload (producer) | Set if the secret is binary or not. | false | boolean |
| operation (producer) | Required The operation to perform. Enum values:
| SecretsManagerOperations | |
| overrideEndpoint (producer) | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean |
| pojoRequest (producer) | If we want to use a POJO request as body or not. | false | boolean |
| profileCredentialsName (producer) | If using a profile credentials provider, this parameter will set the profile name. | String | |
| region (producer) | 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(). Enum values:
| String | |
| uriEndpointOverride (producer) | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. | String | |
| useProfileCredentialsProvider (producer) | Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider. | false | boolean |
| lazyStartProducer (producer (advanced)) | 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 |
| secretsManagerClient (advanced) | Autowired To use an existing configured AWS Secrets Manager client. | SecretsManagerClient | |
| proxyHost (proxy) | To define a proxy host when instantiating the Secrets Manager client. | String | |
| proxyPort (proxy) | To define a proxy port when instantiating the Secrets Manager client. | Integer | |
| proxyProtocol (proxy) | To define a proxy protocol when instantiating the Secrets Manager client. Enum values:
| HTTPS | Protocol |
| accessKey (security) | Amazon AWS Access Key. | String | |
| secretKey (security) | Amazon AWS Secret Key. | String | |
| sessionToken (security) | Amazon AWS Session Token used when the user needs to assume an IAM role. | String | |
| trustAllCertificates (security) | If we want to trust all certificates in case of overriding the endpoint. | false | boolean |
| useDefaultCredentialsProvider (security) | 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 |
| useSessionCredentials (security) | 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 |
12.5.3. Static credentials, Default Credential Provider and Profile Credentials Provider 링크 복사링크가 클립보드에 복사되었습니다!
You can avoid the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and setting it to true.
The order of evaluation for Default Credentials Provider is as per the following:
-
Java system properties -
aws.accessKeyIdandaws.secretKey. -
Environment variables -
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEY. - Web Identity Token from AWS STS.
- The shared credentials and config files.
-
Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable
AWS_CONTAINER_CREDENTIALS_RELATIVE_URIis set. - Amazon EC2 Instance profile credentials.
You can use the Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.
Only one of static, default and profile credentials could be used at the same time. For more information about this, see AWS credentials documentation.
12.5.4. Using AWS Secrets Manager Property Function 링크 복사링크가 클립보드에 복사되었습니다!
To use this function, you 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
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
camel.vault.aws.accessKey = accessKey
camel.vault.aws.secretKey = secretKey
camel.vault.aws.region = region
If you want to use the AWS default credentials provider instead, you need to provide the following env variables:
export CAMEL_VAULT_AWS_USE_DEFAULT_CREDENTIALS_PROVIDER=true export CAMEL_VAULT_AWS_REGION=region
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
camel.vault.aws.defaultCredentialsProvider = true
camel.vault.aws.region = region
It is also possible to specify a particular profile name for accessing AWS Secrets Manager as follows:
export CAMEL_VAULT_AWS_USE_PROFILE_CREDENTIALS_PROVIDER=true export CAMEL_VAULT_AWS_PROFILE_NAME=test-account export CAMEL_VAULT_AWS_REGION=region
export CAMEL_VAULT_AWS_USE_PROFILE_CREDENTIALS_PROVIDER=true
export CAMEL_VAULT_AWS_PROFILE_NAME=test-account
export CAMEL_VAULT_AWS_REGION=region
You can also configure the credentials in the application.properties file such as:
camel.vault.aws.profileCredentialsProvider = true camel.vault.aws.profileName = test-account camel.vault.aws.region = region
camel.vault.aws.profileCredentialsProvider = true
camel.vault.aws.profileName = test-account
camel.vault.aws.region = region
camel.vault.aws configuration only applies to the AWS Secrets Manager properties function (for example, when resolving properties). When using the operation option to create, get, list secrets etc., provide the usual options for connecting to AWS Services.
At this point, you can reference a property in the following way:
Where the 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:
In this case, if the secret doesn’t exist, the property will fall back to "default" as value.
Also, you are able to get a particular field of the secret, if you have, for example, a secret named database of this form:
You can get a single secret value in your route as follows:
Or re-use the property as part of an endpoint.
You can specify a default value in case the particular field of secret is not present on AWS Secret Manager:
In this case, if the secret does not exist or the secret exists, but the username field is not part of the secret, the property will fall back to "admin" as its 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:
This approach will return the RAW route secret with the version 'bf9b4f4b-8e63-43fd-a73c-3e2d3748b451'.
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.
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.
The only requirement is adding the camel-aws-secrets-manager jar to your Camel application.
12.5.5. 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
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
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, set the additional properties as follows:
camel.vault.aws.refreshEnabled=true camel.vault.aws.refreshPeriod=60000 camel.vault.aws.secrets=Secret camel.main.context-reload-enabled = true
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 it is not specified, the task responsible for checking updates events will take it into accounts or the properties with an aws: prefix.
Another option is to use AWS EventBridge in conjunction with the AWS SQS service.
On the AWS side, the following resources need to be created:
- an AWS Couldtrail trail
- an AWS SQS Queue
- an Eventbridge rule of the following kind
This rule will make the event related to AWS Secrets Manager filtered
- You need to set the a Rule target to the AWS SQS Queue for Eventbridge rule
- You need to give permission to the Eventbrige rule, to write on the above SQS Queue. For doing this you’ll need to define a json file like this:
{
"Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"<queue_arn>/SQSDefaultPolicy\",\"Statement\":[{\"Sid\": \"EventsToMyQueue\", \"Effect\": \"Allow\", \"Principal\": {\"Service\": \"events.amazonaws.com\"}, \"Action\": \"sqs:SendMessage\", \"Resource\": \"<queue_arn>\", \"Condition\": {\"ArnEquals\": {\"aws:SourceArn\": \"<eventbridge_rule_arn>\"}}}]}"
}
{
"Policy": "{\"Version\":\"2012-10-17\",\"Id\":\"<queue_arn>/SQSDefaultPolicy\",\"Statement\":[{\"Sid\": \"EventsToMyQueue\", \"Effect\": \"Allow\", \"Principal\": {\"Service\": \"events.amazonaws.com\"}, \"Action\": \"sqs:SendMessage\", \"Resource\": \"<queue_arn>\", \"Condition\": {\"ArnEquals\": {\"aws:SourceArn\": \"<eventbridge_rule_arn>\"}}}]}"
}
Change the values for queue_arn and eventbridge_rule_arn and save the file with policy.json name and run the following command with AWS CLI:
aws sqs set-queue-attributes --queue-url <queue_url> --attributes file://policy.json
aws sqs set-queue-attributes --queue-url <queue_url> --attributes file://policy.json
where queue_url is the AWS SQS Queue URL of the just created Queue.
Now you should be able to set up the configuration on the Camel side. To enable the SQS notification add the following properties:
where queue_url is the AWS SQS Queue URL of the just created Queue.
Whenever an event of PutSecretValue for the Secret named Secret happens, a message will be enqueued in the AWS SQS Queue and consumed on the Camel side and a context reload will be triggered.
12.6. Message Headers 링크 복사링크가 클립보드에 복사되었습니다!
The AWS Secrets Manager component supports 8 message header(s), which is/are listed below:
| Name | Description | Default | Type |
|---|---|---|---|
| CamelAwsSecretsManagerOperation (producer) Constant: OPERATION | The operation we want to perform. | String | |
| CamelAwsSecretsManagerMaxResults (producer) Constant: MAX_RESULTS | The number of results to include in the response. | Integer | |
| CamelAwsSecretsManagerSecretName (producer) Constant: SECRET_NAME | The name of the secret. | String | |
| CamelAwsSecretsManagerSecretDescription (producer) Constant: SECRET_DESCRIPTION | The description of the secret. | String | |
| CamelAwsSecretsManagerSecretId (producer) Constant: SECRET_ID | The ARN or name of the secret. | String | |
| CamelAwsSecretsManagerLambdaRotationFunctionArn (producer) Constant: LAMBDA_ROTATION_FUNCTION_ARN | The ARN of the Lambda rotation function that can rotate the secret. | String | |
| CamelAwsSecretsManagerSecretVersionId (producer) Constant: SECRET_VERSION_ID | The unique identifier of the version of the secret. | String | |
| CamelAwsSecretsManagerSecretReplicationRegions (producer) Constant: SECRET_REPLICATION_REGIONS | A comma separated list of Regions in which to replicate the secret. | String |
12.6.1. 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
12.7. Spring Boot Auto-Configuration 링크 복사링크가 클립보드에 복사되었습니다!
The component 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. | 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 Translate 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 |