Skip to content

Commit 5a2bd92

Browse files
committed
docs(README.md): fixing some docs mistake
1 parent cdf4737 commit 5a2bd92

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ module "stop_ec2_instance" {
3030
autoscaling_schedule = "false"
3131
ec2_schedule = "true"
3232
rds_schedule = "false"
33+
cloudwatch_alarm_schedule = "false"
3334
resources_tag = {
3435
key = "tostop"
3536
value = "true"
@@ -44,6 +45,7 @@ module "start_ec2_instance" {
4445
autoscaling_schedule = "false"
4546
ec2_schedule = "true"
4647
rds_schedule = "false"
48+
cloudwatch_alarm_schedule = "false"
4749
resources_tag = {
4850
key = "tostop"
4951
value = "true"
@@ -53,9 +55,9 @@ module "start_ec2_instance" {
5355

5456
## Examples
5557

56-
* [Autoscaling scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/autoscaling-schedule) - Create lambda functions to suspend autoscaling group with tag `tostop = true` and terminate its ec2 instances on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
57-
* [EC2 scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/ec2-schedule) - Create lambda functions to stop ec2 with tag `tostop = true` on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
58-
* [Rds aurora - mariadb scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/rds-schedule) - Create lambda functions to stop rds mariadb and aurora cluster with tag `tostop = true` on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
58+
* [Autoscaling scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/autoscaling-scheduler) - Create lambda functions to suspend autoscaling group with tag `tostop = true` and terminate its ec2 instances on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
59+
* [EC2 scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/ec2-scheduler) - Create lambda functions to stop ec2 with tag `tostop = true` on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
60+
* [Rds aurora - mariadb scheduler](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/rds-scheduler) - Create lambda functions to stop rds mariadb and aurora cluster with tag `tostop = true` on Friday at 23:00 Gmt and start them on Monday at 07:00 GMT
5961
* [test fixture](https://github.com/diodonfrost/terraform-aws-lambda-scheduler-stop-start/tree/master/examples/test_fixture) - Deploy environment for testing module
6062

6163
## Inputs
@@ -64,6 +66,7 @@ module "start_ec2_instance" {
6466
|------|-------------|------|---------|----------|
6567
| name | Define name to use for lambda function, cloudwatch event and iam role | string | n/a | yes |
6668
| custom_iam_role_arn | Custom IAM role arn for the scheduling lambda | string | null | no |
69+
| tags | Custom tags on aws resources | map | null | no |
6770
| kms_key_arn | The ARN for the KMS encryption key. If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key | string | null | no |
6871
| aws_regions | A list of one or more aws regions where the lambda will be apply, default use the current region | list | null | no |
6972
| cloudwatch_schedule_expression | The scheduling expression | string | `"cron(0 22 ? * MON-FRI *)"` | yes |
@@ -103,7 +106,7 @@ Integration tests are realized with python `boto3` and `pytest` modules.
103106
Install Python dependency:
104107

105108
```shell
106-
python3 -m pip install boto3 pytest pytest-cov pytest-xdist
109+
python3 -m pip install -r requirements-dev.txt
107110
```
108111

109112
```shell

variables.tf

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ variable "cloudwatch_alarm_schedule" {
7373
}
7474

7575
variable "tags" {
76-
description = "Custom tags on lambda"
76+
description = "Custom tags on aws resources"
7777
type = map(any)
7878
default = null
7979
}

0 commit comments

Comments
 (0)