terraform-aws-ec2-ami-backup: An HCL repository from Cloud Posse

This repo contains a terraform module that creates two lambda functions that will create AMI automatically at regular intervals. It is based on the code at https://serverlesscode.com/post/lambda-schedule-ebs-snapshot-backups/ and https://serverlesscode.com/post/lambda-schedule-ebs-snapshot-backups-2/.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Include this repository as a module in your existing terraform code:

module "lambda_ami_backup" {
  source = "git::https://github.com/cloudposse/terraform-aws-ec2-ami-backup.git?ref=tags/0.3.2"

  name           = "${var.name}"
  stage          = "${var.stage}"
  namespace      = "${var.namespace}"
  region         = "${var.region}"
  ami_owner      = "${var.ami_owner}"
  instance_id    = "${var.instance_id}"
  retention_days = "14"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Examples

Example on excluding some of attached EBS volumes:

module "lambda_ami_backup" {
  source = "git::https://github.com/cloudposse/terraform-aws-ec2-ami-backup.git?ref=tags/0.3.2"

  name           = "${var.name}"
  stage          = "${var.stage}"
  namespace      = "${var.namespace}"
  region         = "${var.region}"
  ami_owner      = "${var.ami_owner}"
  instance_id    = "${var.instance_id}"
  retention_days = "14"

  block_device_mappings = [
    { "DeviceName" = "/dev/xvdf", "NoDevice" = "" },
    { "DeviceName" = "/dev/xvdg", "NoDevice" = "" },
  ]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

No requirements.

Providers

Name	Version
archive	n/a
aws	n/a
null	n/a

Modules

Name	Source	Version
label	git::https://github.com/cloudposse/terraform-null-label.git	tags/0.3.7
label_backup	git::https://github.com/cloudposse/terraform-null-label.git	tags/0.3.7
label_cleanup	git::https://github.com/cloudposse/terraform-null-label.git	tags/0.3.7
label_role	git::https://github.com/cloudposse/terraform-null-label.git	tags/0.3.7

Resources

Name	Type
aws_cloudwatch_event_rule.ami_backup	resource
aws_cloudwatch_event_rule.ami_cleanup	resource
aws_cloudwatch_event_target.ami_backup	resource
aws_cloudwatch_event_target.ami_cleanup	resource
aws_iam_role.ami_backup	resource
aws_iam_role_policy.ami_backup	resource
aws_lambda_function.ami_backup	resource
aws_lambda_function.ami_cleanup	resource
aws_lambda_permission.ami_backup	resource
aws_lambda_permission.ami_cleanup	resource
null_resource.schedule	resource
archive_file.ami_backup	data source
archive_file.ami_cleanup	data source
aws_iam_policy_document.ami_backup	data source
aws_iam_policy_document.default	data source

Inputs

Name	Description	Type	Default	Required
ami_owner	AWS Account ID which is used as a filter for AMI list (e.g. `123456789012`)	`string`	`""`	no
backup_schedule	The scheduling expression. (e.g. cron(0 20 * * ? *) or rate(5 minutes)	`string`	`"cron(00 19 * * ? *)"`	no
block_device_mappings	List of block device mappings to be included/excluded from created AMIs. With default value of [], AMIs will include all attached EBS volumes	`list(string)`	`[]`	no
cleanup_schedule	The scheduling expression. (e.g. cron(0 20 * * ? *) or rate(5 minutes)	`string`	`"cron(05 19 * * ? *)"`	no
instance_id	AWS Instance ID which is used for creating the AMI image (e.g. `id-123456789012`)	`any`	n/a	yes
name	Name (e.g. `bastion` or `db`)	`string`	`""`	no
namespace	Namespace (e.g. `cp` or `cloudposse`)	`string`	`""`	no
reboot	Reboot the machine as part of the snapshot process	`string`	`"false"`	no
region	AWS Region where module should operate (e.g. `us-east-1`)	`string`	`""`	no
retention_days	Is the number of days you want to keep the backups for (e.g. `14`)	`string`	`"14"`	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	`string`	`""`	no

Outputs

No outputs.

Related Projects

Check out these related projects.

terraform-aws-ec2-ami-snapshot - Terraform module to easily generate AMI snapshots to create replica instances
terraform-aws-efs-backup - Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline

References

For additional context, refer to some of these links.

Terraform config for automatic EBS snapshots - This repo contains a terraform configuration that creates two lambda functions that will take automatic EBS snapshots at regular intervals.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Source: <https://opensource.org/licenses/MIT>

Trademarks

All other trademarks referenced herein are the property of their respective owners.

cloudposse/terraform-aws-ec2-ami-backup