This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 3c5475b2eb94f182ecd57ef235ced0205316b192 Author: Andrea Cosentino <[email protected]> AuthorDate: Wed Feb 24 14:00:55 2021 +0100 CAMEL-16115 - Remove Camel-AWS-* components - AWS-DDB --- .../org/apache/camel/catalog/components.properties | 2 - .../apache/camel/catalog/components/aws-ddb.json | 62 ---- .../camel/catalog/components/aws-ddbstream.json | 74 ---- .../org/apache/camel/catalog/docs.properties | 2 - .../camel/catalog/docs/aws-ddb-component.adoc | 381 -------------------- .../catalog/docs/aws-ddbstream-component.adoc | 226 ------------ .../component/ComponentsBuilderFactory.java | 2 +- .../src/generated/resources/metadata.json | 46 --- .../builder/endpoint/EndpointBuilderFactory.java | 2 - .../camel/builder/endpoint/EndpointBuilders.java | 2 - .../builder/endpoint/StaticEndpointBuilders.java | 2 +- docs/components/modules/ROOT/nav.adoc | 2 - .../modules/ROOT/pages/aws-ddb-component.adoc | 383 --------------------- .../ROOT/pages/aws-ddbstream-component.adoc | 228 ------------ 14 files changed, 2 insertions(+), 1412 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties index 1e6a039..07b96f5 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties @@ -19,8 +19,6 @@ atomix-set atomix-value avro aws-cw -aws-ddb -aws-ddbstream aws-s3 aws-swf aws2-athena diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddb.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddb.json deleted file mode 100644 index 9717615..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddb.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "component": { - "kind": "component", - "name": "aws-ddb", - "title": "AWS DynamoDB", - "description": "Store and retrieve data from AWS DynamoDB service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.10.0", - "label": "cloud,database,nosql", - "javaType": "org.apache.camel.component.aws.ddb.DdbComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ddb", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ddb", - "extendsScheme": "", - "syntax": "aws-ddb:tableName", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": true, - "lenientProperties": false - }, - "componentProperties": { - "amazonDDBClient": { "kind": "property", "displayName": "Amazon DDBClient", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.AmazonDynamoDB", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To use the AmazonDynamoDB as the client" }, - "autoDiscoverClient": { "kind": "property", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client instan [...] - "configuration": { "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddb.DdbConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, - "consistentRead": { "kind": "property", "displayName": "Consistent Read", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Determines whether or not strong consistency should be enforced when data is read." }, - "keyAttributeName": { "kind": "property", "displayName": "Key Attribute Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Attribute name when creating table" }, - "keyAttributeType": { "kind": "property", "displayName": "Key Attribute Type", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Attribute type when creating table" }, - "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 star [...] - "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddb.DdbOperations", "enum": [ "BatchGetItems", "DeleteItem", "DeleteTable", "DescribeTable", "GetItem", "PutItem", "Query", "Scan", "UpdateItem", "UpdateTable" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "PutItem", "configurationClass": "org.apache.camel.component.aws.ddb.DdbC [...] - "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDB client" }, - "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitalize [...] - "proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the DDB client" }, - "readCapacity": { "kind": "property", "displayName": "Read Capacity", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The provisioned throughput to reserve for reading resources from your table" }, - "region": { "kind": "property", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The region in which DDB client needs to work" }, - "writeCapacity": { "kind": "property", "displayName": "Write Capacity", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The provisioned throughput to reserved for writing resources to your table" }, - "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 t [...] - "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - }, - "properties": { - "tableName": { "kind": "path", "displayName": "Table Name", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The name of the table currently worked with." }, - "amazonDDBClient": { "kind": "parameter", "displayName": "Amazon DDBClient", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.AmazonDynamoDB", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To use the AmazonDynamoDB as the client" }, - "autoDiscoverClient": { "kind": "parameter", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client insta [...] - "consistentRead": { "kind": "parameter", "displayName": "Consistent Read", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Determines whether or not strong consistency should be enforced when data is read." }, - "keyAttributeName": { "kind": "parameter", "displayName": "Key Attribute Name", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Attribute name when creating table" }, - "keyAttributeType": { "kind": "parameter", "displayName": "Key Attribute Type", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Attribute type when creating table" }, - "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 sta [...] - "operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddb.DdbOperations", "enum": [ "BatchGetItems", "DeleteItem", "DeleteTable", "DescribeTable", "GetItem", "PutItem", "Query", "Scan", "UpdateItem", "UpdateTable" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "PutItem", "configurationClass": "org.apache.camel.component.aws.ddb.Ddb [...] - "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDB client" }, - "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitaliz [...] - "proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the DDB client" }, - "readCapacity": { "kind": "parameter", "displayName": "Read Capacity", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The provisioned throughput to reserve for reading resources from your table" }, - "region": { "kind": "parameter", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The region in which DDB client needs to work" }, - "writeCapacity": { "kind": "parameter", "displayName": "Write Capacity", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "The provisioned throughput to reserved for writing resources to your table" }, - "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddb.DdbConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - } -} diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddbstream.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddbstream.json deleted file mode 100644 index a188783..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ddbstream.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "component": { - "kind": "component", - "name": "aws-ddbstream", - "title": "AWS DynamoDB Streams", - "description": "Receive messages from AWS DynamoDB Stream service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.17.0", - "label": "cloud,messaging,streams", - "javaType": "org.apache.camel.component.aws.ddbstream.DdbStreamComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ddb", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ddbstream", - "extendsScheme": "", - "syntax": "aws-ddbstream:tableName", - "async": false, - "api": false, - "consumerOnly": true, - "producerOnly": false, - "lenientProperties": false - }, - "componentProperties": { - "autoDiscoverClient": { "kind": "property", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a c [...] - "amazonDynamoDbStreamsClient": { "kind": "property", "displayName": "Amazon Dynamo Db Streams Client", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreams", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon DynamoDB client to use for [...] - "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 me [...] - "configuration": { "kind": "property", "displayName": "Configuration", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, - "iteratorType": { "kind": "property", "displayName": "Iterator Type", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.model.ShardIteratorType", "enum": [ "TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "LATEST", "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configu [...] - "maxResultsPerRequest": { "kind": "property", "displayName": "Max Results Per Request", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Maximum number of records that will be fetched in each poll" }, - "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDBStreams client" }, - "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "consumer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDBStreams client" }, - "proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the D [...] - "region": { "kind": "property", "displayName": "Region", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "The region in which DDBStreams client needs to work" }, - "sequenceNumberProvider": { "kind": "property", "displayName": "Sequence Number Provider", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddbstream.SequenceNumberProvider", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Provider for the sequence number when [...] - "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 t [...] - "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - }, - "properties": { - "tableName": { "kind": "path", "displayName": "Table Name", "group": "consumer", "label": "consumer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Name of the dynamodb table" }, - "autoDiscoverClient": { "kind": "parameter", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a [...] - "amazonDynamoDbStreamsClient": { "kind": "parameter", "displayName": "Amazon Dynamo Db Streams Client", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreams", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon DynamoDB client to use fo [...] - "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 m [...] - "iteratorType": { "kind": "parameter", "displayName": "Iterator Type", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "com.amazonaws.services.dynamodbv2.model.ShardIteratorType", "enum": [ "TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "LATEST", "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "config [...] - "maxResultsPerRequest": { "kind": "parameter", "displayName": "Max Results Per Request", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Maximum number of records that will be fetched in each poll" }, - "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the DDBStreams client" }, - "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "consumer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the DDBStreams client" }, - "proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the [...] - "region": { "kind": "parameter", "displayName": "Region", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "The region in which DDBStreams client needs to work" }, - "sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." }, - "sequenceNumberProvider": { "kind": "parameter", "displayName": "Sequence Number Provider", "group": "consumer", "label": "consumer", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ddbstream.SequenceNumberProvider", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Provider for the sequence number whe [...] - "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "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 con [...] - "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, - "pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation [...] - "backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, - "backoffIdleThreshold": { "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, - "backoffMultiplier": { "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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 agai [...] - "delay": { "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, - "greedy": { "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, - "initialDelay": { "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, - "repeatCount": { "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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." }, - "runLoggingLevel": { "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level [...] - "scheduledExecutorService": { "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, - "scheduler": { "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, - "schedulerProperties": { "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." }, - "startScheduler": { "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, - "timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, - "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, - "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ddbstream.DdbStreamConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - } -} diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties index b15a7f5..820e76e 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties @@ -23,8 +23,6 @@ attachments avro-component avro-dataformat aws-cw-component -aws-ddb-component -aws-ddbstream-component aws-s3-component aws-summary aws-swf-component diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddb-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddb-component.adoc deleted file mode 100644 index 9d5f675..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddb-component.adoc +++ /dev/null @@ -1,381 +0,0 @@ -[[aws-ddb-component]] -= AWS DynamoDB Component (deprecated) -:docTitle: AWS DynamoDB -:artifactId: camel-aws-ddb -:description: Store and retrieve data from AWS DynamoDB service. -:since: 2.10 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only producer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ddb.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The DynamoDB component supports storing and retrieving data from/to -https://aws.amazon.com/dynamodb[Amazon's DynamoDB] 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 -https://aws.amazon.com/dynamodb[Amazon DynamoDB]. - -== URI Format - -[source,java] ------------------------------- -aws-ddb://domainName[?options] ------------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS DynamoDB component supports 17 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonDDBClient* (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (producer) | The component configuration | | DdbConfiguration -| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| *keyAttributeName* (producer) | Attribute name when creating table | | String -| *keyAttributeType* (producer) | Attribute type when creating table | | 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 [...] -| *operation* (producer) | What operation to perform. There are 10 enums and the value can be one of: BatchGetItems, DeleteItem, DeleteTable, DescribeTable, GetItem, PutItem, Query, Scan, UpdateItem, UpdateTable | PutItem | DdbOperations -| *proxyHost* (producer) | To define a proxy host when instantiating the DDB client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the DDB client. There are 2 enums and the value can be one of: 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 -| *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 -|=== -// component options: END - - - - -// endpoint options: START -The AWS DynamoDB endpoint is configured using URI syntax: - ----- -aws-ddb:tableName ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *tableName* | *Required* The name of the table currently worked with. | | String -|=== - - -=== Query Parameters (15 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonDDBClient* (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| *keyAttributeName* (producer) | Attribute name when creating table | | String -| *keyAttributeType* (producer) | Attribute type when creating table | | 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 [...] -| *operation* (producer) | What operation to perform. There are 10 enums and the value can be one of: BatchGetItems, DeleteItem, DeleteTable, DescribeTable, GetItem, PutItem, Query, Scan, UpdateItem, UpdateTable | PutItem | DdbOperations -| *proxyHost* (producer) | To define a proxy host when instantiating the DDB client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the DDB client. There are 2 enums and the value can be one of: 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 -| *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 -|=== -// endpoint options: END - - - - -Required DDB component options - -You have to provide the amazonDDBClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/dynamodb[Amazon's DynamoDB]. - -== Usage - -=== Message headers evaluated by the DDB producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during BatchGetItems operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during DeleteItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. -|======================================================================= - -=== Message headers set during DeleteTable operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 -|======================================================================= - -=== Message headers set during DescribeTable operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during GetItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== Message headers set during PutItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== Message headers set during Query operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 previous 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. -|======================================================================= - -=== Message headers set during Scan operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 previous 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. -|======================================================================= - -=== Message headers set during UpdateItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== 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: - -[source,java] ----------------------------------------------------- -from("direct:start") -.to("aws-ddb://domainName?amazonDDBClient=#client"); ----------------------------------------------------- - -The `#client` refers to a `AmazonDynamoDB` in the -Registry. - -For example if your Camel Application is running behind a firewall: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonDynamoDB client = new AmazonDynamoDBClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -== Supported producer operations - -- BatchGetItems -- DeleteItem -- DeleteTable -- DescribeTable -- GetItem -- PutItem -- Query -- Scan -- UpdateItem -- UpdateTable - -== Automatic detection of AmazonDynamoDB client in registry - -The component is capable of detecting the presence of an AmazonDynamoDB bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-ddb</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ddb-starter.adoc[] diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddbstream-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddbstream-component.adoc deleted file mode 100644 index 0f070fe..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ddbstream-component.adoc +++ /dev/null @@ -1,226 +0,0 @@ -[[aws-ddbstream-component]] -= AWS DynamoDB Streams Component (deprecated) -:docTitle: AWS DynamoDB Streams -:artifactId: camel-aws-ddb -:description: Receive messages from AWS DynamoDB Stream service. -:since: 2.17 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only consumer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ddbstream.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The 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 https://aws.amazon.com/dynamodb/[AWS DynamoDB] - -== URI Format - -[source,java] ------------------------------------- -aws-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&... - -== URI Options - - -// component options: START -The AWS DynamoDB Streams component supports 14 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking | true | boolean -| *amazonDynamoDbStreamsClient* (consumer) | Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams -| *bridgeErrorHandler* (consumer) | 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 -| *configuration* (consumer) | The component configuration | | DdbStreamConfiguration -| *iteratorType* (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. There are 4 enums and the value can be one of: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER | LATEST | ShardIteratorType -| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | | int -| *proxyHost* (consumer) | To define a proxy host when instantiating the DDBStreams client | | String -| *proxyPort* (consumer) | To define a proxy port when instantiating the DDBStreams client | | Integer -| *proxyProtocol* (consumer) | To define a proxy protocol when instantiating the DDBStreams client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (consumer) | The region in which DDBStreams client needs to work | | String -| *sequenceNumberProvider* (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider -| *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 -|=== -// component options: END - - - - - - -// endpoint options: START -The AWS DynamoDB Streams endpoint is configured using URI syntax: - ----- -aws-ddbstream:tableName ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *tableName* | *Required* Name of the dynamodb table | | String -|=== - - -=== Query Parameters (30 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking | true | boolean -| *amazonDynamoDbStreamsClient* (consumer) | Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams -| *bridgeErrorHandler* (consumer) | 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 -| *iteratorType* (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. There are 4 enums and the value can be one of: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER | LATEST | ShardIteratorType -| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | | int -| *proxyHost* (consumer) | To define a proxy host when instantiating the DDBStreams client | | String -| *proxyPort* (consumer) | To define a proxy port when instantiating the DDBStreams client | | Integer -| *proxyProtocol* (consumer) | To define a proxy protocol when instantiating the DDBStreams client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (consumer) | The region in which DDBStreams client needs to work | | String -| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean -| *sequenceNumberProvider* (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider -| *exceptionHandler* (consumer) | 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. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *pollStrategy* (consumer) | 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. | | PollingConsumerPollStrategy -| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| *backoffMultiplier* (scheduler) | 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. | | int -| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long -| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean -| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long -| *repeatCount* (scheduler) | 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 | long -| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel -| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService -| *scheduler* (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* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map -| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean -| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit -| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - - - -Required DynampDBStream component options - -You have to provide the amazonDynamoDbStreamsClient 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. - -== Batch Consumer - -This component implements the Batch Consumer. - -This allows you for instance to know how many messages exists in this -batch and for instance let the Aggregator -aggregate this number of messages. - -== Usage - -=== AmazonDynamoDBStreamsClient configuration - -You will need to create an instance of AmazonDynamoDBStreamsClient and -bind it to the registry - -[source,java] --------------------------------------------------------------------------------------------------------------------- -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -Region region = Region.getRegion(Regions.fromName(region)); -region.createClient(AmazonDynamoDBStreamsClient.class, null, clientConfiguration); -// the 'null' here is the AWSCredentialsProvider which defaults to an instance of DefaultAWSCredentialsProviderChain - -registry.bind("kinesisClient", client); --------------------------------------------------------------------------------------------------------------------- - -=== Providing AWS Credentials - -It is recommended that the credentials are obtained by using the -http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html[DefaultAWSCredentialsProviderChain] -that is the default when creating a new ClientConfiguration instance, -however, a -different http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/AWSCredentialsProvider.html[AWSCredentialsProvider] -can be specified when calling createClient(...). - -== 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 https://issues.apache.org/jira/browse/CAMEL-9515[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. - -== Automatic detection of AmazonDynamoDBStreams client in registry - -The component is capable of detecting the presence of an AmazonDynamoDBStreams bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ddb-starter.adoc[] diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java index 6636ec21..2362e5e 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java @@ -4708,4 +4708,4 @@ public interface ComponentsBuilderFactory { static org.apache.camel.builder.component.dsl.ZookeeperMasterComponentBuilderFactory.ZookeeperMasterComponentBuilder zookeeperMaster() { return org.apache.camel.builder.component.dsl.ZookeeperMasterComponentBuilderFactory.zookeeperMaster(); } -} +} \ No newline at end of file diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json b/core/camel-componentdsl/src/generated/resources/metadata.json index 9a15e8f..72489e0 100644 --- a/core/camel-componentdsl/src/generated/resources/metadata.json +++ b/core/camel-componentdsl/src/generated/resources/metadata.json @@ -929,52 +929,6 @@ "producerOnly": true, "lenientProperties": false }, - "AwsDdbComponentBuilderFactory": { - "kind": "component", - "name": "aws-ddb", - "title": "AWS DynamoDB", - "description": "Store and retrieve data from AWS DynamoDB service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.10.0", - "label": "cloud,database,nosql", - "javaType": "org.apache.camel.component.aws.ddb.DdbComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ddb", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ddb", - "extendsScheme": "", - "syntax": "aws-ddb:tableName", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": true, - "lenientProperties": false - }, - "AwsDdbstreamComponentBuilderFactory": { - "kind": "component", - "name": "aws-ddbstream", - "title": "AWS DynamoDB Streams", - "description": "Receive messages from AWS DynamoDB Stream service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.17.0", - "label": "cloud,messaging,streams", - "javaType": "org.apache.camel.component.aws.ddbstream.DdbStreamComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ddb", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ddbstream", - "extendsScheme": "", - "syntax": "aws-ddbstream:tableName", - "async": false, - "api": false, - "consumerOnly": true, - "producerOnly": false, - "lenientProperties": false - }, "AwsS3ComponentBuilderFactory": { "kind": "component", "name": "aws-s3", diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java index 8f9d75d..4d1dec6 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java @@ -88,8 +88,6 @@ public interface EndpointBuilderFactory org.apache.camel.builder.endpoint.dsl.DataSetTestEndpointBuilderFactory.DataSetTestBuilders, org.apache.camel.builder.endpoint.dsl.Ddb2EndpointBuilderFactory.Ddb2Builders, org.apache.camel.builder.endpoint.dsl.Ddb2StreamEndpointBuilderFactory.Ddb2StreamBuilders, - org.apache.camel.builder.endpoint.dsl.DdbEndpointBuilderFactory.DdbBuilders, - org.apache.camel.builder.endpoint.dsl.DdbStreamEndpointBuilderFactory.DdbStreamBuilders, org.apache.camel.builder.endpoint.dsl.DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbBuilders, org.apache.camel.builder.endpoint.dsl.DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlBuilders, org.apache.camel.builder.endpoint.dsl.DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresBuilders, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java index d2f21b6..36d128a 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java @@ -85,8 +85,6 @@ public interface EndpointBuilders org.apache.camel.builder.endpoint.dsl.DataSetTestEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.Ddb2EndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.Ddb2StreamEndpointBuilderFactory, - org.apache.camel.builder.endpoint.dsl.DdbEndpointBuilderFactory, - org.apache.camel.builder.endpoint.dsl.DdbStreamEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.DebeziumMongodbEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.DebeziumMySqlEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.DebeziumPostgresEndpointBuilderFactory, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java index ec23280..501a4b2 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java @@ -16532,4 +16532,4 @@ public class StaticEndpointBuilders { return org.apache.camel.builder.endpoint.dsl.ZooKeeperMasterEndpointBuilderFactory.endpointBuilder(componentName, path); } } -//CHECKSTYLE:ON +//CHECKSTYLE:ON \ No newline at end of file diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index 105e85e..841d65d 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -23,8 +23,6 @@ ** xref:avro-component.adoc[Avro RPC] ** xref:aws-summary.adoc[AWS] *** xref:aws-cw-component.adoc[AWS CloudWatch] -*** xref:aws-ddb-component.adoc[AWS DynamoDB] -*** xref:aws-ddbstream-component.adoc[AWS DynamoDB Streams] *** xref:aws-s3-component.adoc[AWS S3 Storage Service] *** xref:aws-swf-component.adoc[AWS Simple Workflow (SWF)] ** xref:aws2-summary.adoc[AWS 2] diff --git a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc b/docs/components/modules/ROOT/pages/aws-ddb-component.adoc deleted file mode 100644 index 84bb89e..0000000 --- a/docs/components/modules/ROOT/pages/aws-ddb-component.adoc +++ /dev/null @@ -1,383 +0,0 @@ -[[aws-ddb-component]] -= AWS DynamoDB Component (deprecated) -//THIS FILE IS COPIED: EDIT THE SOURCE FILE: -:page-source: components/camel-aws-ddb/src/main/docs/aws-ddb-component.adoc -:docTitle: AWS DynamoDB -:artifactId: camel-aws-ddb -:description: Store and retrieve data from AWS DynamoDB service. -:since: 2.10 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only producer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ddb.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The DynamoDB component supports storing and retrieving data from/to -https://aws.amazon.com/dynamodb[Amazon's DynamoDB] 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 -https://aws.amazon.com/dynamodb[Amazon DynamoDB]. - -== URI Format - -[source,java] ------------------------------- -aws-ddb://domainName[?options] ------------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS DynamoDB component supports 17 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonDDBClient* (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (producer) | The component configuration | | DdbConfiguration -| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| *keyAttributeName* (producer) | Attribute name when creating table | | String -| *keyAttributeType* (producer) | Attribute type when creating table | | 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 [...] -| *operation* (producer) | What operation to perform. There are 10 enums and the value can be one of: BatchGetItems, DeleteItem, DeleteTable, DescribeTable, GetItem, PutItem, Query, Scan, UpdateItem, UpdateTable | PutItem | DdbOperations -| *proxyHost* (producer) | To define a proxy host when instantiating the DDB client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the DDB client. There are 2 enums and the value can be one of: 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 -| *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 -|=== -// component options: END - - - - -// endpoint options: START -The AWS DynamoDB endpoint is configured using URI syntax: - ----- -aws-ddb:tableName ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *tableName* | *Required* The name of the table currently worked with. | | String -|=== - - -=== Query Parameters (15 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonDDBClient* (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *consistentRead* (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean -| *keyAttributeName* (producer) | Attribute name when creating table | | String -| *keyAttributeType* (producer) | Attribute type when creating table | | 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 [...] -| *operation* (producer) | What operation to perform. There are 10 enums and the value can be one of: BatchGetItems, DeleteItem, DeleteTable, DescribeTable, GetItem, PutItem, Query, Scan, UpdateItem, UpdateTable | PutItem | DdbOperations -| *proxyHost* (producer) | To define a proxy host when instantiating the DDB client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the DDB client. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the DDB client. There are 2 enums and the value can be one of: 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 -| *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 -|=== -// endpoint options: END - - - - -Required DDB component options - -You have to provide the amazonDDBClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/dynamodb[Amazon's DynamoDB]. - -== Usage - -=== Message headers evaluated by the DDB producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during BatchGetItems operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during DeleteItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. -|======================================================================= - -=== Message headers set during DeleteTable operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 -|======================================================================= - -=== Message headers set during DescribeTable operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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. -|======================================================================= - -=== Message headers set during GetItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== Message headers set during PutItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== Message headers set during Query operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 previous 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. -|======================================================================= - -=== Message headers set during Scan operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|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 previous 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. -|======================================================================= - -=== Message headers set during UpdateItem operation - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsDdbAttributes` |`Map<String, AttributeValue>` |The list of attributes returned by the operation. - -|======================================================================= - -=== 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: - -[source,java] ----------------------------------------------------- -from("direct:start") -.to("aws-ddb://domainName?amazonDDBClient=#client"); ----------------------------------------------------- - -The `#client` refers to a `AmazonDynamoDB` in the -Registry. - -For example if your Camel Application is running behind a firewall: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonDynamoDB client = new AmazonDynamoDBClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -== Supported producer operations - -- BatchGetItems -- DeleteItem -- DeleteTable -- DescribeTable -- GetItem -- PutItem -- Query -- Scan -- UpdateItem -- UpdateTable - -== Automatic detection of AmazonDynamoDB client in registry - -The component is capable of detecting the presence of an AmazonDynamoDB bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-ddb</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ddb-starter.adoc[] diff --git a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc b/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc deleted file mode 100644 index 973c6d9..0000000 --- a/docs/components/modules/ROOT/pages/aws-ddbstream-component.adoc +++ /dev/null @@ -1,228 +0,0 @@ -[[aws-ddbstream-component]] -= AWS DynamoDB Streams Component (deprecated) -//THIS FILE IS COPIED: EDIT THE SOURCE FILE: -:page-source: components/camel-aws-ddb/src/main/docs/aws-ddbstream-component.adoc -:docTitle: AWS DynamoDB Streams -:artifactId: camel-aws-ddb -:description: Receive messages from AWS DynamoDB Stream service. -:since: 2.17 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only consumer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ddbstream.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The 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 https://aws.amazon.com/dynamodb/[AWS DynamoDB] - -== URI Format - -[source,java] ------------------------------------- -aws-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&... - -== URI Options - - -// component options: START -The AWS DynamoDB Streams component supports 14 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking | true | boolean -| *amazonDynamoDbStreamsClient* (consumer) | Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams -| *bridgeErrorHandler* (consumer) | 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 -| *configuration* (consumer) | The component configuration | | DdbStreamConfiguration -| *iteratorType* (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. There are 4 enums and the value can be one of: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER | LATEST | ShardIteratorType -| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | | int -| *proxyHost* (consumer) | To define a proxy host when instantiating the DDBStreams client | | String -| *proxyPort* (consumer) | To define a proxy port when instantiating the DDBStreams client | | Integer -| *proxyProtocol* (consumer) | To define a proxy protocol when instantiating the DDBStreams client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (consumer) | The region in which DDBStreams client needs to work | | String -| *sequenceNumberProvider* (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider -| *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 -|=== -// component options: END - - - - - - -// endpoint options: START -The AWS DynamoDB Streams endpoint is configured using URI syntax: - ----- -aws-ddbstream:tableName ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *tableName* | *Required* Name of the dynamodb table | | String -|=== - - -=== Query Parameters (30 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking | true | boolean -| *amazonDynamoDbStreamsClient* (consumer) | Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams -| *bridgeErrorHandler* (consumer) | 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 -| *iteratorType* (consumer) | Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. There are 4 enums and the value can be one of: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER | LATEST | ShardIteratorType -| *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | | int -| *proxyHost* (consumer) | To define a proxy host when instantiating the DDBStreams client | | String -| *proxyPort* (consumer) | To define a proxy port when instantiating the DDBStreams client | | Integer -| *proxyProtocol* (consumer) | To define a proxy protocol when instantiating the DDBStreams client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (consumer) | The region in which DDBStreams client needs to work | | String -| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean -| *sequenceNumberProvider* (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider -| *exceptionHandler* (consumer) | 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. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *pollStrategy* (consumer) | 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. | | PollingConsumerPollStrategy -| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| *backoffMultiplier* (scheduler) | 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. | | int -| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long -| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean -| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long -| *repeatCount* (scheduler) | 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 | long -| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel -| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService -| *scheduler* (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* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map -| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean -| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit -| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - - - -Required DynampDBStream component options - -You have to provide the amazonDynamoDbStreamsClient 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. - -== Batch Consumer - -This component implements the Batch Consumer. - -This allows you for instance to know how many messages exists in this -batch and for instance let the Aggregator -aggregate this number of messages. - -== Usage - -=== AmazonDynamoDBStreamsClient configuration - -You will need to create an instance of AmazonDynamoDBStreamsClient and -bind it to the registry - -[source,java] --------------------------------------------------------------------------------------------------------------------- -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -Region region = Region.getRegion(Regions.fromName(region)); -region.createClient(AmazonDynamoDBStreamsClient.class, null, clientConfiguration); -// the 'null' here is the AWSCredentialsProvider which defaults to an instance of DefaultAWSCredentialsProviderChain - -registry.bind("kinesisClient", client); --------------------------------------------------------------------------------------------------------------------- - -=== Providing AWS Credentials - -It is recommended that the credentials are obtained by using the -http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html[DefaultAWSCredentialsProviderChain] -that is the default when creating a new ClientConfiguration instance, -however, a -different http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/AWSCredentialsProvider.html[AWSCredentialsProvider] -can be specified when calling createClient(...). - -== 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 https://issues.apache.org/jira/browse/CAMEL-9515[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. - -== Automatic detection of AmazonDynamoDBStreams client in registry - -The component is capable of detecting the presence of an AmazonDynamoDBStreams bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ddb-starter.adoc[]
