Aws2-ddbstream
Since Camel 3.1
Only consumer is supported
The AWS2 DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service.
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon DynamoDB Streams. More information are available at AWS DynamoDB
URI Format
aws2-ddbstream://table-name[?options]
The stream needs to be created prior to it being used.
You can append query options to the URI in the following format,
?options=value&option2=value&…
Required DynamoDBStream component options
You have to provide the DynamoDbStreamsClient in the Registry with proxies and relevant credentials configured.
Sequence Numbers
You can provide a literal string as the sequence number or provide a bean in the registry. An example of using the bean would be to save your current position in the change feed and restore it on Camel startup.
It is an error to provide a sequence number that is greater than the largest sequence number in the describe-streams result, as this will lead to the AWS call returning an HTTP 400.
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 and aws.secretKey
Environment variables - AWS_ACCESS_KEY_ID and AWS_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
Coping with Downtime
AWS DynamoDB Streams outage of less than 24 hours
The consumer will resume from the last seen sequence number (as implemented for CAMEL-9515), so you should receive a flood of events in quick succession, as long as the outage did not also include DynamoDB itself.
AWS DynamoDB Streams outage of more than 24 hours
Given that AWS only retain 24 hours worth of changes, you will have missed change events no matter what mitigations are in place.
Message Body
The Message body is instance of "software.amazon.awssdk.services.dynamodb.model.Record", for more information about it, have a look at the related javadoc
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-ddb</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version} must be replaced by the actual version of
Camel.
Component Configurations
| Name | Description | Default | Type |
|---|---|---|---|
| bridgeErrorHandler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| configuration | The component configuration | object | |
| maxResultsPerRequest | Maximum number of records that will be fetched in each poll | integer | |
| overrideEndpoint | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean |
| region | The region in which DDBStreams client needs to work | string | |
| streamIteratorType | Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. | FROM_LATEST | object |
| uriEndpointOverride | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | string | |
| amazonDynamoDbStreamsClient | Amazon DynamoDB client to use for all requests for this endpoint | object | |
| autowiredEnabled | 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 |
| healthCheckConsumerEnabled | Used for enabling or disabling all consumer based health checks from this component | true | boolean |
| healthCheckProducerEnabled | 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 | To define a proxy host when instantiating the DDBStreams client | string | |
| proxyPort | To define a proxy port when instantiating the DDBStreams client | integer | |
| proxyProtocol | To define a proxy protocol when instantiating the DDBStreams client | HTTPS | object |
| accessKey | Amazon AWS Access Key | string | |
| profileCredentialsName | If using a profile credentials provider this parameter will set the profile name. | string | |
| secretKey | Amazon AWS Secret Key | string | |
| sessionToken | Amazon AWS Session Token used when the user needs to assume a IAM role | string | |
| trustAllCertificates | If we want to trust all certificates in case of overriding the endpoint | false | boolean |
| useDefaultCredentialsProvider | Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean |
| useProfileCredentialsProvider | Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider. | false | boolean |
| useSessionCredentials | Set whether the DDB Streams client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB. | false | boolean |
Endpoint Configurations
| Name | Description | Default | Type |
|---|---|---|---|
| tableName | Name of the dynamodb table | string | |
| maxResultsPerRequest | Maximum number of records that will be fetched in each poll | integer | |
| overrideEndpoint | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean |
| region | The region in which DDBStreams client needs to work | string | |
| sendEmptyMessageWhenIdle | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean |
| streamIteratorType | Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. | FROM_LATEST | object |
| uriEndpointOverride | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | string | |
| amazonDynamoDbStreamsClient | Amazon DynamoDB client to use for all requests for this endpoint | object | |
| bridgeErrorHandler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| exceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | object | |
| exchangePattern | Sets the exchange pattern when the consumer creates an exchange. | object | |
| pollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | object | |
| proxyHost | To define a proxy host when instantiating the DDBStreams client | string | |
| proxyPort | To define a proxy port when instantiating the DDBStreams client | integer | |
| proxyProtocol | To define a proxy protocol when instantiating the DDBStreams client | HTTPS | object |
| backoffErrorThreshold | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | integer | |
| backoffIdleThreshold | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | integer | |
| backoffMultiplier | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | integer | |
| delay | Milliseconds before the next poll. | 500 | integer |
| greedy | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean |
| initialDelay | Milliseconds before the first poll starts. | 1000 | integer |
| repeatCount | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | integer |
| runLoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | object |
| scheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | object | |
| scheduler | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | object |
| schedulerProperties | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | object | |
| startScheduler | Whether the scheduler should be auto started. | true | boolean |
| timeUnit | Time unit for initialDelay and delay options. | MILLISECONDS | object |
| useFixedDelay | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |
| accessKey | Amazon AWS Access Key | string | |
| profileCredentialsName | If using a profile credentials provider this parameter will set the profile name. | string | |
| secretKey | Amazon AWS Secret Key | string | |
| sessionToken | Amazon AWS Session Token used when the user needs to assume a IAM role | string | |
| trustAllCertificates | If we want to trust all certificates in case of overriding the endpoint | false | boolean |
| useDefaultCredentialsProvider | Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | false | boolean |
| useProfileCredentialsProvider | Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider. | false | boolean |
| useSessionCredentials | Set whether the DDB Streams client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in DDB. | false | boolean |