-
Notifications
You must be signed in to change notification settings - Fork 100
/
camel-aws2-s3-sink.json
529 lines (529 loc) · 21 KB
/
camel-aws2-s3-sink.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
{
"connector": {
"class": "org.apache.camel.kafkaconnector.aws2s3.CamelAws2s3SinkConnector",
"artifactId": "camel-aws2-s3-kafka-connector",
"groupId": "org.apache.camel.kafkaconnector",
"id": "camel-aws2-s3-sink",
"type": "sink",
"version": "0.12.0-SNAPSHOT",
"description": "Store and retrieve objects from AWS S3 Storage Service using AWS SDK version 2.x."
},
"properties": {
"camel.sink.path.bucketNameOrArn": {
"name": "camel.sink.path.bucketNameOrArn",
"description": "Bucket name or ARN",
"priority": "HIGH",
"required": "true"
},
"camel.sink.endpoint.amazonS3Client": {
"name": "camel.sink.endpoint.amazonS3Client",
"description": "Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.amazonS3Presigner": {
"name": "camel.sink.endpoint.amazonS3Presigner",
"description": "An S3 Presigner for Request, used mainly in createDownloadLink operation",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.autoCreateBucket": {
"name": "camel.sink.endpoint.autoCreateBucket",
"description": "Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn't exist already.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.overrideEndpoint": {
"name": "camel.sink.endpoint.overrideEndpoint",
"description": "Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.pojoRequest": {
"name": "camel.sink.endpoint.pojoRequest",
"description": "If we want to use a POJO request as body or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.policy": {
"name": "camel.sink.endpoint.policy",
"description": "The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.proxyHost": {
"name": "camel.sink.endpoint.proxyHost",
"description": "To define a proxy host when instantiating the SQS client",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.proxyPort": {
"name": "camel.sink.endpoint.proxyPort",
"description": "Specify a proxy port to be used inside the client definition.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.proxyProtocol": {
"name": "camel.sink.endpoint.proxyProtocol",
"description": "To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]",
"defaultValue": "\"HTTPS\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"HTTP",
"HTTPS"
]
},
"camel.sink.endpoint.region": {
"name": "camel.sink.endpoint.region",
"description": "The region in which S3 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()",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.trustAllCertificates": {
"name": "camel.sink.endpoint.trustAllCertificates",
"description": "If we want to trust all certificates in case of overriding the endpoint",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.uriEndpointOverride": {
"name": "camel.sink.endpoint.uriEndpointOverride",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.useDefaultCredentialsProvider": {
"name": "camel.sink.endpoint.useDefaultCredentialsProvider",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.customerAlgorithm": {
"name": "camel.sink.endpoint.customerAlgorithm",
"description": "Define the customer algorithm to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.customerKeyId": {
"name": "camel.sink.endpoint.customerKeyId",
"description": "Define the id of Customer key to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.customerKeyMD5": {
"name": "camel.sink.endpoint.customerKeyMD5",
"description": "Define the MD5 of Customer key to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.batchMessageNumber": {
"name": "camel.sink.endpoint.batchMessageNumber",
"description": "The number of messages composing a batch in streaming upload mode",
"defaultValue": "10",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.batchSize": {
"name": "camel.sink.endpoint.batchSize",
"description": "The batch size (in bytes) in streaming upload mode",
"defaultValue": "1000000",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.deleteAfterWrite": {
"name": "camel.sink.endpoint.deleteAfterWrite",
"description": "Delete file object after the S3 file has been uploaded",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.keyName": {
"name": "camel.sink.endpoint.keyName",
"description": "Setting the key name for an element in the bucket through endpoint parameter",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.lazyStartProducer": {
"name": "camel.sink.endpoint.lazyStartProducer",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.multiPartUpload": {
"name": "camel.sink.endpoint.multiPartUpload",
"description": "If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.namingStrategy": {
"name": "camel.sink.endpoint.namingStrategy",
"description": "The naming strategy to use in streaming upload mode One of: [progressive] [random]",
"defaultValue": "\"progressive\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"progressive",
"random"
]
},
"camel.sink.endpoint.operation": {
"name": "camel.sink.endpoint.operation",
"description": "The operation to do in case the user don't want to do only an upload One of: [copyObject] [listObjects] [deleteObject] [deleteBucket] [listBuckets] [getObject] [getObjectRange] [createDownloadLink]",
"priority": "MEDIUM",
"required": "false",
"enum": [
"copyObject",
"listObjects",
"deleteObject",
"deleteBucket",
"listBuckets",
"getObject",
"getObjectRange",
"createDownloadLink"
]
},
"camel.sink.endpoint.partSize": {
"name": "camel.sink.endpoint.partSize",
"description": "Setup the partSize which is used in multi part upload, the default size is 25M.",
"defaultValue": "26214400L",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.restartingPolicy": {
"name": "camel.sink.endpoint.restartingPolicy",
"description": "The restarting policy to use in streaming upload mode One of: [override] [lastPart]",
"defaultValue": "\"override\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"override",
"lastPart"
]
},
"camel.sink.endpoint.storageClass": {
"name": "camel.sink.endpoint.storageClass",
"description": "The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.streamingUploadMode": {
"name": "camel.sink.endpoint.streamingUploadMode",
"description": "When stream mode is true the upload to bucket will be done in streaming",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.streamingUploadTimeout": {
"name": "camel.sink.endpoint.streamingUploadTimeout",
"description": "While streaming upload mode is true, this option set the timeout to complete upload",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.awsKMSKeyId": {
"name": "camel.sink.endpoint.awsKMSKeyId",
"description": "Define the id of KMS key to use in case KMS is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.useAwsKMS": {
"name": "camel.sink.endpoint.useAwsKMS",
"description": "Define if KMS must be used or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.useCustomerKey": {
"name": "camel.sink.endpoint.useCustomerKey",
"description": "Define if Customer Key must be used or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.accessKey": {
"name": "camel.sink.endpoint.accessKey",
"description": "Amazon AWS Access Key",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.secretKey": {
"name": "camel.sink.endpoint.secretKey",
"description": "Amazon AWS Secret Key",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.amazonS3Client": {
"name": "camel.component.aws2-s3.amazonS3Client",
"description": "Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.amazonS3Presigner": {
"name": "camel.component.aws2-s3.amazonS3Presigner",
"description": "An S3 Presigner for Request, used mainly in createDownloadLink operation",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.autoCreateBucket": {
"name": "camel.component.aws2-s3.autoCreateBucket",
"description": "Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled and it will create the destinationBucket if it doesn't exist already.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.configuration": {
"name": "camel.component.aws2-s3.configuration",
"description": "The component configuration",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.overrideEndpoint": {
"name": "camel.component.aws2-s3.overrideEndpoint",
"description": "Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.pojoRequest": {
"name": "camel.component.aws2-s3.pojoRequest",
"description": "If we want to use a POJO request as body or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.policy": {
"name": "camel.component.aws2-s3.policy",
"description": "The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.proxyHost": {
"name": "camel.component.aws2-s3.proxyHost",
"description": "To define a proxy host when instantiating the SQS client",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.proxyPort": {
"name": "camel.component.aws2-s3.proxyPort",
"description": "Specify a proxy port to be used inside the client definition.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.proxyProtocol": {
"name": "camel.component.aws2-s3.proxyProtocol",
"description": "To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]",
"defaultValue": "\"HTTPS\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"HTTP",
"HTTPS"
]
},
"camel.component.aws2-s3.region": {
"name": "camel.component.aws2-s3.region",
"description": "The region in which S3 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()",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.trustAllCertificates": {
"name": "camel.component.aws2-s3.trustAllCertificates",
"description": "If we want to trust all certificates in case of overriding the endpoint",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.uriEndpointOverride": {
"name": "camel.component.aws2-s3.uriEndpointOverride",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.useDefaultCredentialsProvider": {
"name": "camel.component.aws2-s3.useDefaultCredentialsProvider",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.customerAlgorithm": {
"name": "camel.component.aws2-s3.customerAlgorithm",
"description": "Define the customer algorithm to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.customerKeyId": {
"name": "camel.component.aws2-s3.customerKeyId",
"description": "Define the id of Customer key to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.customerKeyMD5": {
"name": "camel.component.aws2-s3.customerKeyMD5",
"description": "Define the MD5 of Customer key to use in case CustomerKey is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.batchMessageNumber": {
"name": "camel.component.aws2-s3.batchMessageNumber",
"description": "The number of messages composing a batch in streaming upload mode",
"defaultValue": "10",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.batchSize": {
"name": "camel.component.aws2-s3.batchSize",
"description": "The batch size (in bytes) in streaming upload mode",
"defaultValue": "1000000",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.deleteAfterWrite": {
"name": "camel.component.aws2-s3.deleteAfterWrite",
"description": "Delete file object after the S3 file has been uploaded",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.keyName": {
"name": "camel.component.aws2-s3.keyName",
"description": "Setting the key name for an element in the bucket through endpoint parameter",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.lazyStartProducer": {
"name": "camel.component.aws2-s3.lazyStartProducer",
"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.",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.multiPartUpload": {
"name": "camel.component.aws2-s3.multiPartUpload",
"description": "If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.namingStrategy": {
"name": "camel.component.aws2-s3.namingStrategy",
"description": "The naming strategy to use in streaming upload mode One of: [progressive] [random]",
"defaultValue": "\"progressive\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"progressive",
"random"
]
},
"camel.component.aws2-s3.operation": {
"name": "camel.component.aws2-s3.operation",
"description": "The operation to do in case the user don't want to do only an upload One of: [copyObject] [listObjects] [deleteObject] [deleteBucket] [listBuckets] [getObject] [getObjectRange] [createDownloadLink]",
"priority": "MEDIUM",
"required": "false",
"enum": [
"copyObject",
"listObjects",
"deleteObject",
"deleteBucket",
"listBuckets",
"getObject",
"getObjectRange",
"createDownloadLink"
]
},
"camel.component.aws2-s3.partSize": {
"name": "camel.component.aws2-s3.partSize",
"description": "Setup the partSize which is used in multi part upload, the default size is 25M.",
"defaultValue": "26214400L",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.restartingPolicy": {
"name": "camel.component.aws2-s3.restartingPolicy",
"description": "The restarting policy to use in streaming upload mode One of: [override] [lastPart]",
"defaultValue": "\"override\"",
"priority": "MEDIUM",
"required": "false",
"enum": [
"override",
"lastPart"
]
},
"camel.component.aws2-s3.storageClass": {
"name": "camel.component.aws2-s3.storageClass",
"description": "The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.streamingUploadMode": {
"name": "camel.component.aws2-s3.streamingUploadMode",
"description": "When stream mode is true the upload to bucket will be done in streaming",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.streamingUploadTimeout": {
"name": "camel.component.aws2-s3.streamingUploadTimeout",
"description": "While streaming upload mode is true, this option set the timeout to complete upload",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.awsKMSKeyId": {
"name": "camel.component.aws2-s3.awsKMSKeyId",
"description": "Define the id of KMS key to use in case KMS is enabled",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.useAwsKMS": {
"name": "camel.component.aws2-s3.useAwsKMS",
"description": "Define if KMS must be used or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.useCustomerKey": {
"name": "camel.component.aws2-s3.useCustomerKey",
"description": "Define if Customer Key must be used or not",
"defaultValue": "false",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.autowiredEnabled": {
"name": "camel.component.aws2-s3.autowiredEnabled",
"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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.",
"defaultValue": "true",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.accessKey": {
"name": "camel.component.aws2-s3.accessKey",
"description": "Amazon AWS Access Key",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.aws2-s3.secretKey": {
"name": "camel.component.aws2-s3.secretKey",
"description": "Amazon AWS Secret Key",
"priority": "MEDIUM",
"required": "false"
}
},
"converters": [
"org.apache.camel.kafkaconnector.aws2s3.converters.S3ObjectConverter"
],
"transforms": [
"org.apache.camel.kafkaconnector.aws2s3.transformers.S3ObjectTransforms",
"org.apache.camel.kafkaconnector.aws2s3.transformers.RecordToJSONTransforms",
"org.apache.camel.kafkaconnector.aws2s3.transformers.JSONToRecordTransforms"
],
"aggregationStrategies": [
"org.apache.camel.kafkaconnector.aws2s3.aggregation.NewlineAggregationStrategy"
]
}