{"id":20924419,"url":"https://github.com/validus-risk-management/amazon-kinesis-client-rust","last_synced_at":"2025-07-20T15:32:33.579Z","repository":{"id":65390664,"uuid":"561774096","full_name":"Validus-Risk-Management/amazon-kinesis-client-rust","owner":"Validus-Risk-Management","description":"Amazon Kinesis Client Library for Rust","archived":false,"fork":false,"pushed_at":"2022-12-06T09:17:57.000Z","size":33,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-13T16:37:40.134Z","etag":null,"topics":["aws","aws-kinesis-stream","kcl","kinesis","rust"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/kcl","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Validus-Risk-Management.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-04T13:12:57.000Z","updated_at":"2024-10-01T05:15:37.000Z","dependencies_parsed_at":"2023-01-23T10:54:57.590Z","dependency_job_id":null,"html_url":"https://github.com/Validus-Risk-Management/amazon-kinesis-client-rust","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Validus-Risk-Management/amazon-kinesis-client-rust","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Validus-Risk-Management%2Famazon-kinesis-client-rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Validus-Risk-Management%2Famazon-kinesis-client-rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Validus-Risk-Management%2Famazon-kinesis-client-rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Validus-Risk-Management%2Famazon-kinesis-client-rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Validus-Risk-Management","download_url":"https://codeload.github.com/Validus-Risk-Management/amazon-kinesis-client-rust/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Validus-Risk-Management%2Famazon-kinesis-client-rust/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266151524,"owners_count":23884436,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-kinesis-stream","kcl","kinesis","rust"],"created_at":"2024-11-18T20:22:04.216Z","updated_at":"2025-07-20T15:32:33.549Z","avatar_url":"https://github.com/Validus-Risk-Management.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Amazon Kinesis Client Library for Rust\n[![crates-badge]](https://crates.io/crates/kcl)\n[![docs-badge]](https://docs.rs/kcl)\n[![Crates.io](https://img.shields.io/crates/l/kcl)](LICENSE)\n\nThis package provides a Rust interface to the Amazon Kinesis Client Library (KCL) MultiLangDaemon,\nwhich is part of the [Amazon KCL for Java][kinesis-github].\n\nThis interface manages the interaction with the MultiLangDaemon so that developers can focus on\nimplementing their record processor executable.\n\nThere is a provided Docker image that sets up the correct JARs using the [Amazon KCL for Python][kinesis-python].\n\nA settings file is also required for the MultiLangDaemon to correctly set up your processor.\nA sample of this can be found in the [examples][example-properties].\n\n\n## Basic Usage\n\nA more complete example can be found in the [example][example-consumer]\n\n```rust no_run\nuse kcl::checkpointer::Checkpointer;\nuse kcl::reader::StdinReader;\nuse kcl::writer::StdoutWriter;\nuse kcl::{run, Processor, Record};\nuse serde::Deserialize;\n\n#[derive(Deserialize)]\nstruct DummyPayload;\nstruct BaseApp;\n\nimpl Processor\u003cStdoutWriter, StdinReader\u003e for BaseApp {\n    fn initialize(\u0026mut self, _shard_id: \u0026str) {}\n\n    fn process_records(\n        \u0026mut self,\n        data: \u0026[Record],\n        _checkpointer: \u0026mut Checkpointer\u003cStdoutWriter, StdinReader\u003e,\n    ) {\n        for record in data {\n            match record.json::\u003cDummyPayload\u003e() {\n                Ok(data) =\u003e {}\n                Err(e) =\u003e {}\n            }\n        }\n    }\n    fn lease_lost(\u0026mut self) {}\n    fn shard_ended(\u0026mut self, _checkpointer: \u0026mut Checkpointer\u003cStdoutWriter, StdinReader\u003e) {}\n    fn shutdown_requested(\u0026mut self, _checkpointer: \u0026mut Checkpointer\u003cStdoutWriter, StdinReader\u003e) {}\n}\n\nfn main() {\n    run(\u0026mut BaseApp {});\n}\n\n```\n\n\n## Docker\n\nAn example consumer of this Docker Image would be:\n\n**Compile with al2 because amazoncoretto uses al2**\n\n```dockerfile\nFROM amazonlinux:2 as builder\nRUN yum update -y \u0026\u0026 yum install -y gcc\nRUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y\nENV PATH=\"/root/.cargo/bin:${PATH}\"\nCOPY . .\nRUN cargo build --release\n\nFROM ghcr.io/validus-risk-management/amazon-kinesis-client-rust:latest as runner\nCOPY my-configs/app.properties app.properties\nCOPY --from=builder target/release/my-app target/release/my-app\n```\n\nThe default entrypoint should meet most requirements:\n\n```dockerfile\nCMD [\"java\", \"-cp\", \"/usr/local/lib/jars/*\", \"software.amazon.kinesis.multilang.MultiLangDaemon\", \"--properties-file\", \"app.properties\"]\n```\n\nAdditional configuration can be found [here][kcl-cli-params].\n\n\n[amazon-kcl]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-record-processor-app.html\n[kinesis-github]: https://github.com/awslabs/amazon-kinesis-client\n[kinesis-python]: https://github.com/awslabs/amazon-kinesis-client-python\n[kcl-cli-params]: https://github.com/awslabs/amazon-kinesis-client-python/blob/v2.0.6/samples/amazon_kclpy_helper.py\n[example-properties]: https://github.com/Validus-Risk-Management/amazon-kinesis-client-rust/blob/main/examples/sample.properties\n[example-consumer]: https://github.com/Validus-Risk-Management/amazon-kinesis-client-rust/blob/main/examples/example_consumer/main.rs\n[crates-badge]: https://img.shields.io/crates/v/kcl.svg\n[docs-badge]: https://docs.rs/kcl/badge.svg","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalidus-risk-management%2Famazon-kinesis-client-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalidus-risk-management%2Famazon-kinesis-client-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalidus-risk-management%2Famazon-kinesis-client-rust/lists"}