From 1a7d0b853db45598ec0fab08d1b10e87650d9386 Mon Sep 17 00:00:00 2001 From: Daniel Mangum Date: Mon, 12 Jan 2026 14:39:58 -0500 Subject: [PATCH] pipelines: destinations: add aws-kinesis Adds documentation for the aws-kinesis pipelines data destination. Signed-off-by: Daniel Mangum --- .../4-destinations/17-aws-kinesis.md | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 docs/data-routing/4-destinations/17-aws-kinesis.md diff --git a/docs/data-routing/4-destinations/17-aws-kinesis.md b/docs/data-routing/4-destinations/17-aws-kinesis.md new file mode 100644 index 00000000..170b00a7 --- /dev/null +++ b/docs/data-routing/4-destinations/17-aws-kinesis.md @@ -0,0 +1,71 @@ +--- +title: aws-kinesis +--- + +| | | +|---|:---:| +|__Latest Version__| `v1.0.0` | +|__Input Content Type__| Any | + +:::usage +Sending data to Kinesis incurs usage costs after exceeding the free tier. See +[Golioth pricing](https://golioth.io/pricing) for more information. +::: + +The `aws-kinesis` destination sends data to an [Amazon Web Services +Kinesis](https://aws.amazon.com/kinesis/) Data Stream. + +### Parameters + +|Parameter|Type|Description|Required| +|---|---|---|:---:| +|`stream_arn`|`string`| The [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) of the Kinesis Data Stream. |✅| +|`access_key`|`string`| The access key for authentication. |✅| +|`access_secret`|`string`| The access secret for authentication. |✅| +|`region`|`string`| The AWS region for the Kinesis Data Stream. |✅| + +The device ID is used as the data stream [partition +key](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key). + +### Example Secrets + +`AWS_ACCESS_SECRET` +``` +wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY +``` + +### Example Usage + +```yaml + destination: + type: aws-kinesis + version: v1 + parameters: + stream_arn: my-bucket + access_key: AKIAIOSFODNN7EXAMPLE + access_secret: $AWS_ACCESS_SECRET + region: us-east-1 +``` + +### Example Input + +```json +{ + "temp": 32 +} +``` + +### Example Output + +Output data will match input data exactly, regardless of content type. Because +message metadata is not automatically injected into the payload, it is common to +use a transformer such as +[`inject-metadata`](/data-routing/transformers/inject-metadata) with the +`aws-kinesis` data destination. + +```json +{ + "temp": 32 +} +``` +