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

Infrascan scanner definition for AWS S3

# @infrascan/aws-s3-scanner

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

This module pulls information about the S3 resources in an AWS account by calling: `ListBuckets`, `GetBucketTagging`, `GetBucketNotificationConfiguration`, `GetBucketWebsite`, and `GetBucketAcl`.

## Quickstart

```javascript
import S3Scanner from "@infrascan/aws-s3-scanner";
import Infrascan from "@infrascan/sdk";

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

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.