kinesis-stream
Adaptavist/kinesis-stream/module
Kinesis Data Streams Auto Scaling A lightweight system to automatically scale Kinesis Data Streams up and down based on throughput. !Kinesis_Auto_Scaling Event Flow - Step 1: Metrics flow from the Kinesis Data Stream(s) into CloudWatch Metrics (Bytes/Sec, Records/Sec) - Step 2: Two alarms, Scale Up and Scale Down, evaluate those metrics and decide when to scale - Step 3: When a scaling alarm triggers it sends a message to the Scaling SNS Topic - Step 4: The Scaling Lambda processes that SNS message and… - Scales the Kinesis Data Stream up or down using UpdateShardCount - Scale Up events double the number of shards in the stream - Scale Down events halve the number of shards in the stream - Updates the metric math on the Scale Up and Scale Down alarms to reflect the new shard count. Feature
| Name | Type | Description | Default |
|---|---|---|---|
| stream_name | string | Stream Name | |
| tags | map(string) | Map of tags that should be applied to all resources | |
| shard_count | number | Number of Shards | |
| min_shard_count | number | Minimum Number of Shards greater than zero | |
| kms_key_id | string | KMS Key | |
| kinesis_scale_up_threshold | number | Scale up threshold | 0.75 |
| kinesis_scale_up_evaluation_period | number | Period after which the data for the alarm will be evaluated to scale up | 5 |
| kinesis_scale_down_min_iter_age_mins | number | To compare with streams max iterator age. If the streams max iterator age is abo | 30 |
| enable_slack_notification | bool | Enable Scale Notification | false |
| stream_retention_period | number | Stream Retention Period | 24 |
| kinesis_scaling_period_mins | number | Scaling Period in minute | 5 |
| slack_web_hook_url | string | Slack Web hook URL | "" |
| kinesis_scale_up_datapoints_required | number | Number of datapoints required in the evaluationPeriod to trigger the alarm to sc | 5 |
| kinesis_scale_down_threshold | number | Scale down threshold | 0.25 |
| encryption_type | string | Encryption Key | "KMS" |
| kinesis_scale_down_datapoints_required | number | Number of datapoints required in the evaluationPeriod to trigger the alarm to sc | 57 |
| max_shard_scaling_factor | number | Maximum factor by which min_shard_count can scale. For example, given min_shard_ | 5 |
| kinesis_cooldown_mins | number | Cooling down Period in minutes | 10 |
| kinesis_scale_down_evaluation_period | number | Period after which the data for the alarm will be evaluated to scale down | 60 |
kinesis_stream_arn