Chapter 6. AWS DynamoDB
Chapter 6. AWS DynamoDB Only producer is supported The AWS2 DynamoDB component supports storing and retrieving data from/to service. Prerequisites You must have a valid Amazon Web Services developer account, and be signed up to use Amazon DynamoDB. More information is available at Amazon DynamoDB . 6.1. Dependencies When using aws2-ddb 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-aws2-ddb-starter</artifactId> </dependency> 6.2. URI Format aws2-ddb://domainName[?options] You can append query options to the URI in the following format, ?options=value&option2=value&... 6.3. Configuring Options Camel components are configured on two levels: Component level Endpoint level 6.3.1. Component Level Options The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on. Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all. You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code. 6.3.2. Endpoint Level Options At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both. You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java. When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings. Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code. 6.4. Component Options The AWS DynamoDB component supports 22 options, which are listed below. Name Description Default Type amazonDDBClient (producer) Autowired To use the AmazonDynamoDB as the client. DynamoDbClient configuration (producer) The component configuration. Ddb2Configuration consistentRead (producer) Determines whether or not strong consistency should be enforced when data is read. false boolean enabledInitialDescribeTable (producer) Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. true boolean keyAttributeName (producer) Attribute name when creating table. String keyAttributeType (producer) Attribute type when creating table. String keyScalarType (producer) The key scalar type, it can be S (String), N (Number) and B (Bytes). String 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) What operation to perform. Enum values: BatchGetItems DeleteItem DeleteTable DescribeTable GetItem PutItem Query Scan UpdateItem UpdateTable PutItem Ddb2Operations overrideEndpoint (producer) Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false boolean proxyHost (producer) To define a proxy host when instantiating the DDB client. String proxyPort (producer) The region in which DynamoDB 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(). Integer proxyProtocol (producer) To define a proxy protocol when instantiating the DDB client. Enum values: HTTP HTTPS HTTPS Protocol readCapacity (producer) The provisioned throughput to reserve for reading resources from your table. Long region (producer) The region in which DDB client needs to work. String trustAllCertificates (producer) If we want to trust all certificates in case of overriding the endpoint. false boolean uriEndpointOverride (producer) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String useDefaultCredentialsProvider (producer) Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. false boolean writeCapacity (producer) The provisioned throughput to reserved for writing resources to your table. Long 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 accessKey (security) Amazon AWS Access Key. String secretKey (security) Amazon AWS Secret Key. String 6.5. Endpoint Options The AWS DynamoDB endpoint is configured using URI syntax: with the following path and query parameters: 6.5.1. Path Parameters (1 parameters) Name Description Default Type tableName (producer) Required The name of the table currently worked with. String 6.5.2. Query Parameters (20 parameters) Name Description Default Type amazonDDBClient (producer) Autowired To use the AmazonDynamoDB as the client. DynamoDbClient consistentRead (producer) Determines whether or not strong consistency should be enforced when data is read. false boolean enabledInitialDescribeTable (producer) Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. true boolean keyAttributeName (producer) Attribute name when creating table. String keyAttributeType (producer) Attribute type when creating table. String keyScalarType (producer) The key scalar type, it can be S (String), N (Number) and B (Bytes). String 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) What operation to perform. Enum values: BatchGetItems DeleteItem DeleteTable DescribeTable GetItem PutItem Query Scan UpdateItem UpdateTable PutItem Ddb2Operations overrideEndpoint (producer) Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false boolean proxyHost (producer) To define a proxy host when instantiating the DDB client. String proxyPort (producer) The region in which DynamoDB 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(). Integer proxyProtocol (producer) To define a proxy protocol when instantiating the DDB client. Enum values: HTTP HTTPS HTTPS Protocol readCapacity (producer) The provisioned throughput to reserve for reading resources from your table. Long region (producer) The region in which DDB client needs to work. String trustAllCertificates (producer) If we want to trust all certificates in case of overriding the endpoint. false boolean uriEndpointOverride (producer) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String useDefaultCredentialsProvider (producer) Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. false boolean writeCapacity (producer) The provisioned throughput to reserved for writing resources to your table. Long accessKey (security) Amazon AWS Access Key. String secretKey (security) Amazon AWS Secret Key. String Required DDB component options You have to provide the amazonDDBClient in the Registry or your accessKey and secretKey to access the Amazon's DynamoDB . 6.6. Usage 6.6.1. Static credentials vs Default Credential Provider You have the possibility of avoiding the usage of explicit static credentials, by specifying the useDefaultCredentialsProvider option and set it to true. 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. For more information about this you can look at AWS credentials documentation 6.6.2. Message headers evaluated by the DDB producer Header Type Description CamelAwsDdbBatchItems Map<String, KeysAndAttributes> A map of the table name and corresponding items to get by primary key. CamelAwsDdbTableName String Table Name for this operation. CamelAwsDdbKey Key The primary key that uniquely identifies each item in a table. CamelAwsDdbReturnValues String Use this parameter if you want to get the attribute name-value pairs before or after they are modified(NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW). CamelAwsDdbUpdateCondition Map<String, ExpectedAttributeValue> Designates an attribute for a conditional modification. CamelAwsDdbAttributeNames Collection<String> If attribute names are not specified then all attributes will be returned. CamelAwsDdbConsistentRead Boolean If set to true, then a consistent read is issued, otherwise eventually consistent is used. CamelAwsDdbIndexName String If set will be used as Secondary Index for Query operation. CamelAwsDdbItem Map<String, AttributeValue> A map of the attributes for the item, and must include the primary key values that define the item. CamelAwsDdbExactCount Boolean If set to true, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. CamelAwsDdbKeyConditions Map<String, Condition> This header specify the selection criteria for the query, and merge together the two old headers CamelAwsDdbHashKeyValue and CamelAwsDdbScanRangeKeyCondition CamelAwsDdbStartKey Key Primary key of the item from which to continue an earlier query. CamelAwsDdbHashKeyValue AttributeValue Value of the hash component of the composite primary key. CamelAwsDdbLimit Integer The maximum number of items to return. CamelAwsDdbScanRangeKeyCondition Condition A container for the attribute values and comparison operators to use for the query. CamelAwsDdbScanIndexForward Boolean Specifies forward or backward traversal of the index. CamelAwsDdbScanFilter Map<String, Condition> Evaluates the scan results and returns only the desired values. CamelAwsDdbUpdateValues Map<String, AttributeValueUpdate> Map of attribute name to the new value and action for the update. 6.6.3. Message headers set during BatchGetItems operation Header Type Description CamelAwsDdbBatchResponse Map<String,BatchResponse> Table names and the respective item attributes from the tables. CamelAwsDdbUnprocessedKeys Map<String,KeysAndAttributes> Contains a map of tables and their respective keys that were not processed with the current response. 6.6.4. Message headers set during DeleteItem operation Header Type Description CamelAwsDdbAttributes Map<String, AttributeValue> The list of attributes returned by the operation. 6.6.5. Message headers set during DeleteTable operation Header Type Description CamelAwsDdbProvisionedThroughput ProvisionedThroughputDescription The value of the ProvisionedThroughput property for this table CamelAwsDdbCreationDate Date Creation DateTime of this table. CamelAwsDdbTableItemCount Long Item count for this table. CamelAwsDdbKeySchema KeySchema The KeySchema that identifies the primary key for this table. From Camel 2.16.0 the type of this header is List<KeySchemaElement> and not KeySchema CamelAwsDdbTableName String The table name. CamelAwsDdbTableSize Long The table size in bytes. CamelAwsDdbTableStatus String The status of the table: CREATING, UPDATING, DELETING, ACTIVE 6.6.6. Message headers set during DescribeTable operation Header Type Description CamelAwsDdbProvisionedThroughput \{{ProvisionedThroughputDescription}} The value of the ProvisionedThroughput property for this table CamelAwsDdbCreationDate Date Creation DateTime of this table. CamelAwsDdbTableItemCount Long Item count for this table. CamelAwsDdbKeySchema \{{KeySchema}} The KeySchema that identifies the primary key for this table. CamelAwsDdbTableName String The table name. CamelAwsDdbTableSize Long The table size in bytes. CamelAwsDdbTableStatus String The status of the table: CREATING, UPDATING, DELETING, ACTIVE CamelAwsDdbReadCapacity Long ReadCapacityUnits property of this table. CamelAwsDdbWriteCapacity Long WriteCapacityUnits property of this table. 6.6.7. Message headers set during GetItem operation Header Type Description CamelAwsDdbAttributes Map<String, AttributeValue> The list of attributes returned by the operation. 6.6.8. Message headers set during PutItem operation Header Type Description CamelAwsDdbAttributes Map<String, AttributeValue> The list of attributes returned by the operation. 6.6.9. Message headers set during Query operation Header Type Description CamelAwsDdbItems List<java.util.Map<String,AttributeValue>> The list of attributes returned by the operation. CamelAwsDdbLastEvaluatedKey Key Primary key of the item where the query operation stopped, inclusive of the result set. CamelAwsDdbConsumedCapacity Double The number of Capacity Units of the provisioned throughput of the table consumed during the operation. CamelAwsDdbCount Integer Number of items in the response. 6.6.10. Message headers set during Scan operation Header Type Description CamelAwsDdbItems List<java.util.Map<String,AttributeValue>> The list of attributes returned by the operation. CamelAwsDdbLastEvaluatedKey Key Primary key of the item where the query operation stopped, inclusive of the result set. CamelAwsDdbConsumedCapacity Double The number of Capacity Units of the provisioned throughput of the table consumed during the operation. CamelAwsDdbCount Integer Number of items in the response. CamelAwsDdbScannedCount Integer Number of items in the complete scan before any filters are applied. 6.6.11. Message headers set during UpdateItem operation Header Type Description CamelAwsDdbAttributes Map<String, AttributeValue> The list of attributes returned by the operation. 6.6.12. Advanced AmazonDynamoDB configuration If you need more control over the AmazonDynamoDB instance configuration you can create your own instance and refer to it from the URI: from("direct:start") .to("aws2-ddb://domainName?amazonDDBClient=#client"); The #client refers to a DynamoDbClient in the Registry. 6.7. Supported producer operations BatchGetItems DeleteItem DeleteTable DescribeTable GetItem PutItem Query Scan UpdateItem UpdateTable 6.8. Examples 6.8.1. Producer Examples PutItem: this operation will create an entry into DynamoDB from("direct:start") .setHeader(Ddb2Constants.OPERATION, Ddb2Operations.PutItem) .setHeader(Ddb2Constants.CONSISTENT_READ, "true") .setHeader(Ddb2Constants.RETURN_VALUES, "ALL_OLD") .setHeader(Ddb2Constants.ITEM, attributeMap) .setHeader(Ddb2Constants.ATTRIBUTE_NAMES, attributeMap.keySet()); .to("aws2-ddb://" + tableName + "?keyAttributeName=" + attributeName + "&keyAttributeType=" + KeyType.HASH + "&keyScalarType=" + ScalarAttributeType.S + "&readCapacity=1&writeCapacity=1"); 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>USD{camel-version}</version> </dependency> where {camel-version} must be replaced by the actual version of Camel. 6.9. Spring Boot Auto-Configuration The component supports 40 options, which are listed below. Name Description Default Type camel.component.aws2-ddb.access-key Amazon AWS Access Key. String camel.component.aws2-ddb.amazon-d-d-b-client To use the AmazonDynamoDB as the client. The option is a software.amazon.awssdk.services.dynamodb.DynamoDbClient type. DynamoDbClient camel.component.aws2-ddb.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.aws2-ddb.configuration The component configuration. The option is a org.apache.camel.component.aws2.ddb.Ddb2Configuration type. Ddb2Configuration camel.component.aws2-ddb.consistent-read Determines whether or not strong consistency should be enforced when data is read. false Boolean camel.component.aws2-ddb.enabled Whether to enable auto configuration of the aws2-ddb component. This is enabled by default. Boolean camel.component.aws2-ddb.enabled-initial-describe-table Set whether the initial Describe table operation in the DDB Endpoint must be done, or not. true Boolean camel.component.aws2-ddb.key-attribute-name Attribute name when creating table. String camel.component.aws2-ddb.key-attribute-type Attribute type when creating table. String camel.component.aws2-ddb.key-scalar-type The key scalar type, it can be S (String), N (Number) and B (Bytes). String camel.component.aws2-ddb.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.aws2-ddb.operation What operation to perform. Ddb2Operations camel.component.aws2-ddb.override-endpoint Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false Boolean camel.component.aws2-ddb.proxy-host To define a proxy host when instantiating the DDB client. String camel.component.aws2-ddb.proxy-port The region in which DynamoDB 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(). Integer camel.component.aws2-ddb.proxy-protocol To define a proxy protocol when instantiating the DDB client. Protocol camel.component.aws2-ddb.read-capacity The provisioned throughput to reserve for reading resources from your table. Long camel.component.aws2-ddb.region The region in which DDB client needs to work. String camel.component.aws2-ddb.secret-key Amazon AWS Secret Key. String camel.component.aws2-ddb.trust-all-certificates If we want to trust all certificates in case of overriding the endpoint. false Boolean camel.component.aws2-ddb.uri-endpoint-override Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String camel.component.aws2-ddb.use-default-credentials-provider Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. false Boolean camel.component.aws2-ddb.write-capacity The provisioned throughput to reserved for writing resources to your table. Long camel.component.aws2-ddbstream.access-key Amazon AWS Access Key. String camel.component.aws2-ddbstream.amazon-dynamo-db-streams-client Amazon DynamoDB client to use for all requests for this endpoint. The option is a software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient type. DynamoDbStreamsClient camel.component.aws2-ddbstream.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.aws2-ddbstream.bridge-error-handler Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 camel.component.aws2-ddbstream.configuration The component configuration. The option is a org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration type. Ddb2StreamConfiguration camel.component.aws2-ddbstream.enabled Whether to enable auto configuration of the aws2-ddbstream component. This is enabled by default. Boolean camel.component.aws2-ddbstream.max-results-per-request Maximum number of records that will be fetched in each poll. Integer camel.component.aws2-ddbstream.override-endpoint Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false Boolean camel.component.aws2-ddbstream.proxy-host To define a proxy host when instantiating the DDBStreams client. String camel.component.aws2-ddbstream.proxy-port To define a proxy port when instantiating the DDBStreams client. Integer camel.component.aws2-ddbstream.proxy-protocol To define a proxy protocol when instantiating the DDBStreams client. Protocol camel.component.aws2-ddbstream.region The region in which DDBStreams client needs to work. String camel.component.aws2-ddbstream.secret-key Amazon AWS Secret Key. String camel.component.aws2-ddbstream.stream-iterator-type 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. Ddb2StreamConfigurationUSDStreamIteratorType camel.component.aws2-ddbstream.trust-all-certificates If we want to trust all certificates in case of overriding the endpoint. false Boolean camel.component.aws2-ddbstream.uri-endpoint-override Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String camel.component.aws2-ddbstream.use-default-credentials-provider 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
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-aws2-ddb-starter</artifactId> </dependency> aws2-ddb://domainName[?options] aws2-ddb:tableName from("direct:start") .to("aws2-ddb://domainName?amazonDDBClient=#client"); from("direct:start") .setHeader(Ddb2Constants.OPERATION, Ddb2Operations.PutItem) .setHeader(Ddb2Constants.CONSISTENT_READ, "true") .setHeader(Ddb2Constants.RETURN_VALUES, "ALL_OLD") .setHeader(Ddb2Constants.ITEM, attributeMap) .setHeader(Ddb2Constants.ATTRIBUTE_NAMES, attributeMap.keySet()); .to("aws2-ddb://" + tableName + "?keyAttributeName=" + attributeName + "&keyAttributeType=" + KeyType.HASH + "&keyScalarType=" + ScalarAttributeType.S + "&readCapacity=1&writeCapacity=1"); <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-aws2-ddb</artifactId> <version>USD{camel-version}</version> </dependency>