@infrascan/aws-kinesis-scanner/README.md

Infrascan scanner definition for AWS Kinesis

# @infrascan/aws-kinesis-scanner

A scanner module for AWS Kinesis, designed to be used with the [@infrascan/sdk](../../packages/sdk).

This module pulls information about the Kinesis resources in an AWS account by calling: `ListStreams`, and `ListStreamConsumers`.

## Quickstart

```javascript
import KinesisScanner from "@infrascan/aws-kinesis-scanner";
import Infrascan from "@infrascan/sdk";

const infrascanClient = new Infrascan();
infrascanClient.registerScanner(KinesisScanner);
```

If you plan on scanning all of an AWS account, you should use the [@infrascan/aws](../../packages/aws) package.

## Contributing

The majority of the scanner modules are autogenerated from their [config.ts](./config.ts) file. 

Changes such as adding a new function/endpoint in the service to scan can be done within the config file. 

More significant changes will likely need to take place in the [aws-codegen](../codegen) package.