AWS Timestream
Since Camel 4.1
Only producer is supported
The AWS2 Timestream component supports the following operations on AWS Timestream:
-
Write Operations
-
Describe Write Endpoints
-
Create, Describe, Resume, List Batch Load Tasks
-
Create, Delete, Update, Describe, List Databases
-
Create, Delete, Update, Describe, List Tables
-
Write Records
-
-
Query Operations
-
Describe Query Endpoints
-
Prepare Query, Query, Cancel Query
-
Create, Delete, Execute, Update, Describe, List Scheduled Queries
-
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Timestream. More information is available at AWS Timestream.
URI Format
aws2-timestream://clientType: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
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.
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.
Component Options
The AWS Timestream component supports 21 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Component configuration. | Timestream2Configuration | ||
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. It can be describeEndpoints,createBatchLoadTask,describeBatchLoadTask, resumeBatchLoadTask,listBatchLoadTasks,createDatabase,deleteDatabase,describeDatabase,updateDatabase, listDatabases,createTable,deleteTable,describeTable,updateTable,listTables,writeRecords, createScheduledQuery,deleteScheduledQuery,executeScheduledQuery,updateScheduledQuery, describeScheduledQuery,listScheduledQueries,prepareQuery,query,cancelQuery. Enum values:
| Timestream2Operations | ||
Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean | |
If we want to use a POJO request as body or not. | false | boolean | |
If using a profile credentials provider, this parameter will set the profile name. | String | ||
The region in which the Timestream 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 | ||
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 Timestream client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | |
Set whether the Timestream client should expect to load credentials through a profile credentials provider. | 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 | |
Autowired To use an existing configured AwsTimestreamQueryClient client. | TimestreamQueryClient | ||
Autowired To use an existing configured AwsTimestreamWriteClient client. | TimestreamWriteClient | ||
Used for enabling or disabling all consumer based health checks from this component. | true | boolean | |
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 | |
To define a proxy host when instantiating the Timestream client. | String | ||
To define a proxy port when instantiating the Timestream client. | Integer | ||
To define a proxy protocol when instantiating the Timestream client. Enum values:
| HTTPS | Protocol | |
Amazon AWS Access Key. | String | ||
Amazon AWS Secret Key. | String |
Endpoint Options
The AWS Timestream endpoint is configured using URI syntax:
aws2-timestream:clientType:label
With the following path and query parameters:
Query Parameters (17 parameters)
Name | Description | Default | Type |
---|---|---|---|
Required The operation to perform. It can be describeEndpoints,createBatchLoadTask,describeBatchLoadTask, resumeBatchLoadTask,listBatchLoadTasks,createDatabase,deleteDatabase,describeDatabase,updateDatabase, listDatabases,createTable,deleteTable,describeTable,updateTable,listTables,writeRecords, createScheduledQuery,deleteScheduledQuery,executeScheduledQuery,updateScheduledQuery, describeScheduledQuery,listScheduledQueries,prepareQuery,query,cancelQuery. Enum values:
| Timestream2Operations | ||
Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. | false | boolean | |
If we want to use a POJO request as body or not. | false | boolean | |
If using a profile credentials provider, this parameter will set the profile name. | String | ||
The region in which the Timestream 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 | ||
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 Timestream client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean | |
Set whether the Timestream client should expect to load credentials through a profile credentials provider. | 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 | |
Autowired To use an existing configured AwsTimestreamQueryClient client. | TimestreamQueryClient | ||
Autowired To use an existing configured AwsTimestreamWriteClient client. | TimestreamWriteClient | ||
To define a proxy host when instantiating the Timestream client. | String | ||
To define a proxy port when instantiating the Timestream client. | Integer | ||
To define a proxy protocol when instantiating the Timestream client. Enum values:
| HTTPS | Protocol | |
Amazon AWS Access Key. | String | ||
Amazon AWS Secret Key. | String |
Required Timestream component options
Based on the type of operation to be performed, the type of client (write/query) needs to be provided as clientType URI path parameter
You have to provide either the awsTimestreamWriteClient(for write operations) or awsTimestreamQueryClient(for query operations) in the Registry or your accessKey and secretKey to access the AWS Timestream service.
Message Headers
The AWS Timestream component supports 38 message header(s), which is/are listed below:
Name | Description | Default | Type |
---|---|---|---|
CamelAwsTimestreamOperation (producer) Constant: | The operation we want to perform. | String | |
CamelAwsTimestreamRecord (producer) Constant: | Represents a time-series data point being written into Timestream. | Record | |
CamelAwsTimestreamRecordList (producer) Constant: | List of Records. | List | |
CamelAwsTimestreamTaskStatus (producer) Constant: | Status of Batch Load Task. | String | |
CamelAwsTimestreamTaskId (producer) Constant: | The ID of the batch load task to resume. | String | |
CamelAwsTimestreamDatabaseName (producer) Constant: | Name of Database. | String | |
CamelAwsTimestreamTableName (producer) Constant: | Name of Table. | String | |
CamelAwsTimestreamTargetDatabaseName (producer) Constant: | Name of Target Database. | String | |
CamelAwsTimestreamTargetTableName (producer) Constant: | Name of Target Table. | String | |
CamelAwsTimestreamRecordVersion (producer) Constant: | Record version. | String | |
CamelAwsTimestreamDataModelConfiguration (producer) Constant: | Configuration of Data Model. | DataModelConfiguration | |
CamelAwsTimestreamDataSourceConfiguration (producer) Constant: | Configuration of Data Source. | DataSourceConfiguration | |
CamelAwsTimestreamReportConfiguration (producer) Constant: | Reporting Configuration. | ReportConfiguration | |
CamelAwsTimestreamTableSchema (producer) Constant: | Timestream Table Schema. | Schema | |
CamelAwsTimestreamRetentionProperties (producer) Constant: | Timestream Table Retention Properties. | RetentionProperties | |
CamelAwsTimestreamMagneticStoreWriteProperties (producer) Constant: | Timestream Table Magentic Store Write properties. | MagneticStoreWriteProperties | |
CamelAwsTimestreamTimeColumn (producer) Constant: | Name of Time column. | String | |
CamelAwsTimestreamMeasureColumnName (producer) Constant: | Name of the measure column. | String | |
CamelAwsTimestreamDimensionMappingList (producer) Constant: | This is to allow mapping column(s) from the query result to the dimension in the destination table. | List | |
CamelAwsTimestreamMultiMeasureMappings (producer) Constant: | Multi-measure mappings. | MultiMeasureMappings | |
CamelAwsTimestreamMixedMeasureMappingList (producer) Constant: | Specifies how to map measures to multi-measure records. | List | |
CamelAwsTimestreamScheduledQueryName (producer) Constant: | Name of scheduled query. | String | |
CamelAwsTimestreamScheduledQueryArn (producer) Constant: | Arn of scheduled query. | String | |
CamelAwsTimestreamScheduledQueryState (producer) Constant: | State of scheduled query. | String | |
CamelAwsTimestreamScheduledQueryInvocationTime (producer) Constant: | Invocation Time for scheduled query execution. | Instant | |
CamelAwsTimestreamQueryString (producer) Constant: | The query string to run. | String | |
CamelAwsTimestreamQueryId (producer) Constant: | ID of query. | String | |
CamelAwsTimestreamQueryValidateOnly (producer) Constant: | Validates the prepared query, but does not store for later execution. | Boolean | |
CamelAwsTimestreamQueryMaxRows (producer) Constant: | The total number of rows to be returned in the Query output. | Integer | |
CamelAwsTimestreamMaxResults (producer) Constant: | Max Results to be returned in output. | Integer | |
CamelAwsTimestreamScheduleExpression (producer) Constant: | The schedule expression for the query. | String | |
CamelAwsTimestreamNotificationTopicArn (producer) Constant: | Notification Topic Arn for the scheduled query. | String | |
CamelAwsTimestreamErrorReportS3BucketName (producer) Constant: | S3 Bucket name for error reporting. | String | |
CamelAwsTimestreamErrorReportS3ObjectKeyPrefix (producer) Constant: | S3 object key prefix for error reporting. | String | |
CamelAwsTimestreamErrorReportS3EncryptionOption (producer) Constant: | S3 encryption option for error reporting. | String | |
CamelAwsTimestreamScheduledQueryExecutionRoleArn (producer) Constant: | he ARN for the IAM role that Timestream will assume when running the scheduled query. | String | |
CamelAwsTimestreamClientToken (producer) Constant: | Using a ClientToken makes the call to CreateScheduledQuery idempotent. | String | |
CamelAwsTimestreamKmsKeyId (producer) Constant: | The Amazon KMS key used to encrypt the scheduled query resource, at-rest. | String |
Usage
Static credentials, Default Credential Provider and Profile Credentials Provider
You have the possibility of avoiding the usage of 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.accessKeyId
andaws.secretKey
. -
Environment variables -
AWS_ACCESS_KEY_ID
andAWS_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_URI
is set. -
Amazon EC2 Instance profile credentials.
You have also the possibility of using 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 you can look at AWS credentials documentation
Timestream Producer operations
Camel-AWS Timestream component provides the following operation on the producer side:
-
Write Operations
-
describeEndpoints
-
createBatchLoadTask
-
describeBatchLoadTask
-
resumeBatchLoadTask
-
listBatchLoadTasks
-
createDatabase
-
deleteDatabase
-
describeDatabase
-
updateDatabase
-
listDatabases
-
createTable
-
deleteTable
-
describeTable
-
updateTable
-
listTables
-
writeRecords
-
-
Query Operations
-
describeEndpoints
-
createScheduledQuery
-
deleteScheduledQuery
-
executeScheduledQuery
-
updateScheduledQuery
-
describeScheduledQuery
-
listScheduledQueries
-
prepareQuery
-
query
-
cancelQuery
-
Examples
Producer Examples
-
Write Operation
-
createDatabase: this operation will create a timestream database
-
from("direct:createDatabase")
.setHeader(Timestream2Constants.DATABASE_NAME, constant("testDb"))
.setHeader(Timestream2Constants.KMS_KEY_ID, constant("testKmsKey"))
.to("aws2-timestream://write:test?awsTimestreamWriteClient=#awsTimestreamWriteClient&operation=createDatabase")
-
Query Operation
-
query: this operation will execute a timestream query
-
from("direct:query")
.setHeader(Timestream2Constants.QUERY_STRING, constant("SELECT * FROM testDb.testTable ORDER BY time DESC LIMIT 10"))
.to("aws2-timestream://query:test?awsTimestreamQueryClient=#awsTimestreamQueryClient&operation=query")
Using a POJO as body
Sometimes building an AWS Request can be complex because of multiple options. We introduce the possibility to use a POJO as the body. In AWS Timestream there are multiple operations you can submit, as an example for Create state machine request, you can do something like:
-
Write Operation
-
createDatabase: this operation will create a timestream database
-
from("direct:start")
.setBody(CreateDatabaseRequest.builder().database(Database.builder().databaseName("testDb").kmsKeyId("testKmsKey").build()).build())
.to("aws2-timestream://write:test?awsTimestreamWriteClient=#awsTimestreamWriteClient&operation=createDatabase&pojoRequest=true")
-
Query Operation
-
query: this operation will execute a timestream query
-
from("direct:query")
.setBody(QueryRequest.builder().queryString("SELECT * FROM testDb.testTable ORDER BY time DESC LIMIT 10").build())
.to("aws2-timestream://query:test?awsTimestreamQueryClient=#awsTimestreamQueryClient&operation=query&pojoRequest=true")
In this way, you’ll pass the request directly without the need of passing headers and options specifically related to this operation.
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws2-timestream</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version}
must be replaced by the actual version of Camel.
Spring Boot Auto-Configuration
When using aws2-timestream 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-aws2-timestream-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 22 options, which are listed below.