| {"component":{"kind":"component","name":"aws2-ddb","title":"AWS DynamoDB","description":"Store and retrieve data from AWS DynamoDB service using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,database,nosql","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ddb","version":"3.18.1","scheme":"aws2-ddb","extendsScheme":"","syntax":"aws2-ddb:tableName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsDdbAttributes":{"kind":"header","displayName":"","group":"DeleteItem GetItem PutItem UpdateItem","label":"DeleteItem GetItem PutItem UpdateItem","required":false,"javaType":"Map<String, AttributeValue>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTES"},"CamelAwsDdbAttributeNames":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Collection<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If attribute names are not specified then all attributes will be returned.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ATTRIBUTE_NAMES"},"CamelAwsDdbBatchItems":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, KeysAndAttributes>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the table name and corresponding items to get by primary key.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_ITEMS"},"CamelAwsDdbBatchResponse":{"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map<String, BatchResponse>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table names and the respective item attributes from the tables.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#BATCH_RESPONSE"},"CamelAwsDdbConsistentRead":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set to true, then a consistent read is issued, otherwise eventually consistent is used.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSISTENT_READ"},"CamelAwsDdbConsumedCapacity":{"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of Capacity Units of the provisioned throughput of the table consumed during the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CONSUMED_CAPACITY"},"CamelAwsDdbCount":{"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#COUNT"},"CamelAwsDdbCreationDate":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Creation DateTime of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#CREATION_DATE"},"CamelAwsDdbIndexName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If set will be used as Secondary Index for Query operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#INDEX_NAME"},"CamelAwsDdbItem":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, AttributeValue>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A map of the attributes for the item, and must include the primary key values that define the item.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM"},"CamelAwsDdbItems":{"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"List<Map<String,AttributeValue>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of attributes returned by the operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEMS"},"CamelAwsDdbTableItemCount":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Item count for this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#ITEM_COUNT"},"CamelAwsDdbKey":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, AttributeValue>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The primary key that uniquely identifies each item in a table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY"},"CamelAwsDdbKeyConditions":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, Condition>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"This header specify the selection criteria for the query, and merge together the two old headers CamelAwsDdbHashKeyValue and CamelAwsDdbScanRangeKeyCondition","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_CONDITIONS"},"CamelAwsDdbKeySchema":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"List<KeySchemaElement>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The KeySchema that identifies the primary key for this table. From Camel 2.16.0 the type of this header is List and not KeySchema","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#KEY_SCHEMA"},"CamelAwsDdbLastEvaluatedKey":{"kind":"header","displayName":"","group":"Query Scan","label":"Query Scan","required":false,"javaType":"Key","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item where the query operation stopped, inclusive of the previous result set.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LAST_EVALUATED_KEY"},"CamelAwsDdbLimit":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of items to return.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#LIMIT"},"CamelAwsDdbOperation":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The operation to perform.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#OPERATION"},"CamelAwsDdbProvisionedThroughput":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"software.amazon.awssdk.services.dynamodb.model.ProvisionedThroughputDescription","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of the ProvisionedThroughput property for this table","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#PROVISIONED_THROUGHPUT"},"CamelAwsDdbReadCapacity":{"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"ReadCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#READ_CAPACITY"},"CamelAwsDdbReturnValues":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"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).","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#RETURN_VALUES"},"CamelAwsDdbScannedCount":{"kind":"header","displayName":"","group":"Scan","label":"Scan","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of items in the complete scan before any filters are applied.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCANNED_COUNT"},"CamelAwsDdbScanIndexForward":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies forward or backward traversal of the index.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_INDEX_FORWARD"},"CamelAwsDdbScanFilter":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, Condition>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Evaluates the scan results and returns only the desired values.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#SCAN_FILTER"},"CamelAwsDdbStartKey":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, AttributeValue>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Primary key of the item from which to continue an earlier query.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#START_KEY"},"CamelAwsDdbTableName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Table Name for this operation.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_NAME"},"CamelAwsDdbTableSize":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The table size in bytes.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_SIZE"},"CamelAwsDdbTableStatus":{"kind":"header","displayName":"","group":"DeleteTable DescribeTable","label":"DeleteTable DescribeTable","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The status of the table: CREATING, UPDATING, DELETING, ACTIVE","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#TABLE_STATUS"},"CamelAwsDdbUpdateCondition":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, ExpectedAttributeValue>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Designates an attribute for a conditional modification.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_CONDITION"},"CamelAwsDdbUpdateValues":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Map<String, AttributeValueUpdate>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Map of attribute name to the new value and action for the update.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UPDATE_VALUES"},"CamelAwsDdbUnprocessedKeys":{"kind":"header","displayName":"","group":"BatchGetItems","label":"BatchGetItems","required":false,"javaType":"Map<String,KeysAndAttributes>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Contains a map of tables and their respective keys that were not processed with the current response.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#UNPROCESSED_KEYS"},"CamelAwsDdbWriteCapacity":{"kind":"header","displayName":"","group":"UpdateTable DescribeTable","label":"UpdateTable DescribeTable","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"WriteCapacityUnits property of this table.","constantName":"org.apache.camel.component.aws2.ddb.Ddb2Constants#WRITE_CAPACITY"}},"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.aws2.ddb.Ddb2Configuration","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":"software.amazon.awssdk.services.dynamodb.DynamoDbClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"To use the AmazonDynamoDB as the client"},"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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Determines whether or not strong consistency should be enforced when data is read."},"enabledInitialDescribeTable":{"kind":"parameter","displayName":"Enabled Initial Describe Table","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the initial Describe table operation in the DDB Endpoint must be done, or not."},"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.aws2.ddb.Ddb2Configuration","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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Attribute type when creating table"},"keyScalarType":{"kind":"parameter","displayName":"Key Scalar Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The key scalar type, it can be S (String), N (Number) and B (Bytes)"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.ddb.Ddb2Operations","enum":["BatchGetItems","DeleteItem","DeleteTable","DescribeTable","GetItem","PutItem","Query","Scan","UpdateItem","UpdateTable"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PutItem","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"What operation to perform"},"overrideEndpoint":{"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"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.aws2.ddb.Ddb2Configuration","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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DynamoDB client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","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.aws2.ddb.Ddb2Configuration","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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The region in which DDB client needs to work"},"trustAllCertificates":{"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"The provisioned throughput to reserved for writing resources to your table"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","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 starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"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.aws2.ddb.Ddb2Configuration","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.aws2.ddb.Ddb2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}} |