AWS Kinesis

Discover more about the AWS Kinesis connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

AWS Kinesis consumes and produces records from and to AWS Kinesis Streams using AWS SDK version 2.x.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Dynamic Account	When active, the connector will use the account dynamically. Otherwise, it will use the account statically.	False	Boolean
Account Name (DB)	The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.	N/A	String
Account	The account used by the connector. It is only available if the Dynamic Account parameter is inactive.	N/A	Account
Stream Name (DB)	Name of the stream.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	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 the Uri Endpoint Override option.	False	Boolean
Pojo Request	Whether to use a POJO request as body or not.	False	Boolean
Region (DB)	The region in which the Kinesis Firehouse 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	Whether to trust all certificates in case of overriding the endpoint.	False	Boolean
Uri Endpoint Override (DB)	Set the overriding URI endpoint. This option needs to be used in combination with the Override Endpoint option.	N/A	String

Headers tab

Parameter	Description	Default value	Data type
Sequence Number (DB)	The sequence number of the record, as defined in the Amazon documentation.	N/A	String
Approximate Arrival Timestamp (DB)	The time AWS assigned as the arrival time of the record.	N/A	String
Partition Key (DB)	Identifies which shard in the stream the data record is assigned to.	N/A	String
Timestamp	The timestamp of the message.	N/A	Integer
Shard Id (DB)	The shard ID of the shard where the data record was placed.	N/A	String

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String