Skip to content

Commit df66db1

Browse files
authored
chore: fix docs (#20)
1 parent 7be7e51 commit df66db1

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/API.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ export class App extends cdk.Stack {
8888
Quick option rundown:
8989
- `sites`: The list of allowed sites. This does not have to be a domain name, it can also be string. It can be anything
9090
you want to use to identify a site. The client-side script that sends analytics will have to specify one of these names.
91+
- `firehoseBufferInterval`: The number in seconds for the Firehose buffer interval. The default is 15 minutes (900 seconds), minimum is 60 and
92+
maximum is 900.
9193
- `allowedOrigins`: The origins that are allowed to make requests to the backend Ingest API. This CORS check is done as an extra
9294
security measure to prevent other sites from making requests to your backend. It must include the protocol and
9395
full domain. Ex: If your site is `example.com` and it can be accessed using `https://example.com` and
@@ -105,6 +107,7 @@ Quick option rundown:
105107
CloudFront(`cloudfront.net`) and Cognito(`auth.us-east-1.amazoncognito.com`) domains. You can read the website URL
106108
from the stack output.
107109
- `observability`: Adds a CloudWatch Dashboard and Alarms if specified.
110+
- `rateLimit`: Adds a rate limit to the Ingest API and Frontend/Dashboard API. Defaults to 200 and 100 respectively.
108111

109112
For a full list of options see the [API.md](https://github.com/rehanvdm/serverless-website-analytics/blob/main/docs/API.md#api-reference-) docs.
110113

0 commit comments

Comments
 (0)