terraform-aws-lambda-scheduler-stop-start

Stop and start ec2, rds resources and autoscaling groups with lambda function.

Terraform versions

For Terraform 0.12 use version v2.* of this module.

If you are using Terraform 0.11 you can use versions v1.*.

Features

• Aws lambda runtine Python 3.7
• ec2 instances scheduling
• spot instances scheduling
• rds clusters scheduling
• rds instances scheduling
• autoscalings scheduling
• Aws cloudWatch logs for lambda

Caveats

You can't stop and start an Amazon Spot instance (only the Spot service can stop and start a Spot Instance), but you can reboot or terminate a Spot Instance. That why this module support only scheduler action terminate for spot instance.

Usage

module "stop_ec2_instance" {
  source                         = "diodonfrost/lambda-scheduler-stop-start/aws"
  name                           = "ec2_stop"
  cloudwatch_schedule_expression = "cron(0 00 ? * FRI *)"
  schedule_action                = "stop"
  autoscaling_schedule           = "false"
  spot_schedule                  = "terminate"
  ec2_schedule                   = "true"
  rds_schedule                   = "false"
  autoscaling_schedule           = "false"
  resources_tag                  = {
    key   = "tostop"
    value = "true"
  }
}

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
• Spot scheduler - Create lambda functions to stop spot instance with tag tostop = true on Friday at 23:00 Gmt
• 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
• Rds aurora - mariadb 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
• test fixture - Deploy environment for testing module

Inputs

Name	Description	Type	Default	Required
name	Define name to use for lambda function, cloudwatch event and iam role	string	n/a	yes
cloudwatch_schedule_expression	The scheduling expression	string	"cron(0 22 ? * MON-FRI *)"	yes
schedule_action	Define schedule action to apply on resources	string	"stop"	yes
resources_tag	Set the tag use for identify resources to stop or start	map	{ tostop = "true" }	yes
autoscaling_schedule	Enable scheduling on autoscaling resources	string	"false"	no
spot_schedule	Enable scheduling on spot instance resources	string	"false"	no
ec2_schedule	Enable scheduling on ec2 instance resources	string	"false"	no
rds_schedule	Enable scheduling on rds resources	string	"false"	no

Outputs

Name	Description
lambda_iam_role_arn	The ARN of the IAM role used by Lambda function
lambda_iam_role_name	The name of the IAM role used by Lambda function
scheduler_lambda_arn	The ARN of the Lambda function
scheduler_lambda_name	The name of the Lambda function
scheduler_lambda_invoke_arn	The ARN to be used for invoking Lambda function from API Gateway
scheduler_lambda_function_last_modified	The date Lambda function was last modified
scheduler_lambda_function_version	Latest published version of your Lambda function

Tests

This module has been packaged with Terratest to tests this Terraform module.

Some of these tests create real resources in an AWS account. That means they cost money to run, especially if you don't clean up after yourself. Please be considerate of the resources you create and take extra care to clean everything up when you're done!

In order to run tests that access your AWS account, you will need to configure your AWS CLI credentials. For example, you could set the credentials as the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

Install Terratest with depedencies:

# Prerequisite: install Go
go get ./...

# Test ec2 scheduler
go test -v test/integration/ec2_scheduler_test.go

# Test spot scheduler
go test -v test/integration/spot_scheduler_test.go

# Test autoscaling scheduler
go test -v test/integration/autoscaling_scheduler_test.go

Authors

Modules managed by diodonfrost

Licence

Apache 2 Licensed. See LICENSE for full details.

Resources

• cloudwatch schedule expressions
• Python boto3 ec2
• Python boto3 rds
• Python boto3 autoscaling
• Terratest