AWS Secrets Manager Sink
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Creates a secret in AWS Secrets Manager for each message, with the body as its value, or changes or reads the value of an existing secret.
Use it to store passwords, API keys or certificates that another system generates, so that your applications can read them from Secrets Manager, to rotate such a value, or to read one inside a route.
Input: the body is the value of the secret, as text, for example a password, or several values as a JSON object in JSON text. With operation set to getSecret, the body is not used. For createSecret, the name of the new secret comes from the secret-name header, else from the ce-secret-name header; without either, the ID of the message is used as the name. updateSecret and getSecret work on the secret in secretId.
Output: when it is used inside a route, the body afterwards is the answer of AWS, a CreateSecretResponse object of the AWS SDK for Java with the ARN, the name and the version ID of the new secret; for updateSecret, an UpdateSecretResponse with the ARN, the name and the new version ID. For getSecret, the body is the value of the secret, as text, or as bytes for a binary secret, and the CamelAwsSecretsManagerSecretVersionId header holds the ID of its version.
Good to know: by default it only creates secrets, and a message for a name that already exists fails. Set operation to updateSecret to change the value of the existing secret in secretId, or to getSecret to read it; both fail when secretId is not set or the secret does not exist. A message without a name header creates a secret with a generated name, such as 4D678616B8AFAA1-0000000000000002. With binaryPayload, the body is stored as the binary value of the secret instead of as text. To reach AWS through an HTTP proxy, set proxyHost and proxyPort, and set proxyProtocol to HTTP for a proxy that takes plain HTTP, such as Squid. Headers that start with CamelAwsSecretsManager are removed from the message first, so they cannot change what the Kamelet does.
Configuration Options
The following table summarizes the configuration options available for the aws-secrets-manager-sink Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
AWS Region | Required The AWS region to create the secrets in, such as Enum values: * ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global | string | eu-west-1 | ||
Access Key | The access key ID of an IAM user, which AWS gives when you create an access key for the user (in the AWS console: IAM, Users, Security credentials). Use it together with | string | |||
Binary Payload | If true, | boolean | true | ||
Operation | What to do with each message: Enum values: * createSecret * updateSecret * getSecret | string | createSecret | updateSecret | |
Profile Credentials Name | The name of the profile to use from the AWS credentials file. Only used when | string | |||
Proxy Host | The host name or IP address of an HTTP proxy to send the calls to AWS through, such as the proxy of a company network. Used only together with | string | proxy.example.com | ||
Proxy Port | The port of the proxy in | integer | 3128 | ||
Proxy Protocol | How to talk to the proxy itself: Enum values: * HTTP * HTTPS | string | HTTP | ||
Secret ID | The name or the ARN of the secret that | string | prod/db-password | ||
Secret Key | The secret access key that goes with | string | |||
Session Token | The session token of temporary credentials, which AWS gives together with their access key and secret key. Only used when | string | |||
Default Credentials Provider | If true, the credentials are found the way the AWS SDK finds them: from the | boolean | false | ||
Profile Credentials Provider | If true, the credentials are read from a profile of the AWS credentials file ( | boolean | false | ||
Session Credentials | If true, it logs in with temporary credentials, such as those of an assumed IAM role: | boolean | false |
Dependencies
At runtime, the aws-secrets-manager-sink Kamelet relies upon the presence of the following dependencies:
-
camel:aws-secrets-manager
-
camel:kamelet
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:aws-secrets-manager-sink" You can now run it directly through the following command
camel run route.yaml AWS Secrets Manager Sink Kamelet Description
Authentication methods
In this Kamelet you can avoid using explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.
The order of evaluation for Default Credentials Provider is 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 also use the Profile Credentials Provider, by setting the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.
Only one of access key/secret key or default credentials provider could be used
For more information, see the AWS credentials documentation
Headers
The Kamelet reads the following header:
-
secret-name/ce-secret-name: as the name of the secret to create.
If the header is not set, the ID of the message is used as secret name.
Changing or Reading a Secret
By default, the Kamelet creates a new secret for each message, and a message for a name that already exists fails. Set operation to work with the existing secret named in secretId, by its name or its ARN:
-
createSecret(the default): creates a new secret with the body as its value, named from thesecret-nameheader as above.secretIdis not used. -
updateSecret: stores the body as the new value of the secret, as a new version. The version before stays available as the previous one (AWSPREVIOUS). -
getSecret: reads the current value of the secret into the body, as text, or as bytes for a binary secret. TheCamelAwsSecretsManagerSecretVersionIdheader holds the ID of the version that was read.
updateSecret and getSecret need secretId: without it, each message fails with The secretId option must be set. They also fail for a secret that does not exist.
With binaryPayload set to true, createSecret and updateSecret store the bytes of the body as the binary value of the secret, for example a keystore file, instead of as text.
The step that sends to the Kamelet, in a route, to rotate a password, with the new password in the body:
- to:
uri: "kamelet:aws-secrets-manager-sink"
parameters:
region: "eu-west-1"
useDefaultCredentialsProvider: true
operation: "updateSecret"
secretId: "prod/db-password" Through an HTTP Proxy
Where AWS can be reached only through an HTTP proxy, as in many company networks, set proxyHost and proxyPort to the proxy. proxyProtocol is how the Kamelet talks to the proxy itself, not to AWS: it is HTTPS when it is not set, so set it to HTTP for a proxy that takes plain HTTP, such as Squid. The calls to AWS stay encrypted, as the proxy only passes them on. The Kamelet has no option for a proxy user or password.
The step that sends to the Kamelet, in a route:
- to:
uri: "kamelet:aws-secrets-manager-sink"
parameters:
region: "eu-west-1"
useDefaultCredentialsProvider: true
proxyHost: "proxy.example.com"
proxyPort: 3128
proxyProtocol: "HTTP"