AWS Kinesis
Discover more about the AWS Kinesis connector and how to use it on the Digibee Integration Platform.
Important information:
This documentation is currently available only in English but will soon be translated into Portuguese.
The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.
Consume and produce records from and to AWS Kinesis Streams using AWS SDK version 2.x.
Parameters
Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB)
.
Required Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Dynamic Account | When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically. | false | boolean |
Account Name | The name of the account that is generated dynamically via the Store Account connector. | string | |
Account | Sets the account to be used by the connector. | N/A | Account |
Stream Name | Name of the stream | N/A | string |
Fail On Error | If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false | false | boolean |
Optional Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Cbor Enabled | This option will set the CBOR_ENABLED property during the execution | true | boolean |
Override Endpoint | Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option | false | boolean |
Region | The region in which Kinesis Firehose 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() | N/A | string |
Trust All Certificates | If we want to trust all certificates in case of overriding the endpoint | false | boolean |
Uri Endpoint Override | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | N/A | string |
Headers Tab
Parameter | Description | Default value | Data type |
---|---|---|---|
CamelAwsKinesisSequenceNumber | The sequence number of the record, as defined in the Syntax. | N/A | string |
CamelAwsKinesisApproximateArrivalTimestamp | The time AWS assigned as the arrival time of the record. | N/A | string |
CamelAwsKinesisPartitionKey | Identifies which shard in the stream the data record is assigned to. | N/A | string |
CamelMessageTimestamp | The timestamp of the message | N/A | number |
CamelAwsKinesisShardId | The shard ID of the shard where the data record was placed. | N/A | string |
Successful executions should output at least a property "success": true
Last updated