# AWS Kinesis

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**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](https://docs.digibee.com/documentation/connectors-and-triggers/double-braces/overview) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>When active, the connector will use the account dynamically. Otherwise, it will use the account statically.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>The name of the dynamic account used by the connector. This account must have been previously configured in a <a href="../tools/store-account"><strong>Store Account</strong></a> connector in the pipeline for this process to take effect. It is only available if the <strong>Dynamic Account</strong> parameter is active.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>The account used by the connector. It is only available if the <strong>Dynamic Account</strong> parameter is inactive.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Stream Name</strong> <code>(DB)</code></td><td>Name of the stream.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>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 <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Cbor Enabled</strong></td><td>This option will set the CBOR_ENABLED property during the execution.</td><td>True</td><td>Boolean</td></tr><tr><td><strong>Override Endpoint</strong></td><td>Set the need for overidding the endpoint. This option needs to be used in combination with the <strong>Uri Endpoint Override</strong> option.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Pojo Request</strong></td><td>Whether to use a POJO request as body or not.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Region</strong> <code>(DB)</code></td><td>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()</td><td>N/A</td><td>String</td></tr><tr><td><strong>Trust All Certificates</strong></td><td>Whether to trust all certificates in case of overriding the endpoint.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Uri Endpoint Override</strong> <code>(DB)</code></td><td>Set the overriding URI endpoint. This option needs to be used in combination with the Override <strong>Endpoint</strong> option.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Sequence Number</strong> <code>(DB)</code></td><td>The sequence number of the record, as defined in the <a href="http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse">Amazon documentation</a>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Approximate Arrival Timestamp</strong> <code>(DB)</code></td><td>The time AWS assigned as the arrival time of the record.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Partition Key</strong> <code>(DB)</code></td><td>Identifies which shard in the stream the data record is assigned to.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Timestamp</strong></td><td>The timestamp of the message.</td><td>N/A</td><td>Integer</td></tr><tr><td><strong>Shard Id</strong> <code>(DB)</code></td><td>The shard ID of the shard where the data record was placed.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>