Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-ec2-ami-backup/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-ec2-ami-backup/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-ami-backup.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-ec2-ami-backup/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-ami-backup.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

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. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

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" = "" },
  ]
}
<!-- markdownlint-disable -->

Makefile Targets

Available targets:

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

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

No requirements.

Providers

NameVersion
<a name="provider_archive"></a> archiven/a
<a name="provider_aws"></a> awsn/a
<a name="provider_null"></a> nulln/a

Modules

NameSourceVersion
<a name="module_label"></a> labelgit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.7
<a name="module_label_backup"></a> label_backupgit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.7
<a name="module_label_cleanup"></a> label_cleanupgit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.7
<a name="module_label_role"></a> label_rolegit::https://github.com/cloudposse/terraform-null-label.gittags/0.3.7

Resources

NameType
aws_cloudwatch_event_rule.ami_backupresource
aws_cloudwatch_event_rule.ami_cleanupresource
aws_cloudwatch_event_target.ami_backupresource
aws_cloudwatch_event_target.ami_cleanupresource
aws_iam_role.ami_backupresource
aws_iam_role_policy.ami_backupresource
aws_lambda_function.ami_backupresource
aws_lambda_function.ami_cleanupresource
aws_lambda_permission.ami_backupresource
aws_lambda_permission.ami_cleanupresource
null_resource.scheduleresource
archive_file.ami_backupdata source
archive_file.ami_cleanupdata source
aws_iam_policy_document.ami_backupdata source
aws_iam_policy_document.defaultdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_ami_owner"></a> ami_ownerAWS Account ID which is used as a filter for AMI list (e.g. 123456789012)string""no
<a name="input_backup_schedule"></a> backup_scheduleThe scheduling expression. (e.g. cron(0 20 * * ? *) or rate(5 minutes)string"cron(00 19 * * ? *)"no
<a name="input_block_device_mappings"></a> block_device_mappingsList of block device mappings to be included/excluded from created AMIs. With default value of [], AMIs will include all attached EBS volumeslist(string)[]no
<a name="input_cleanup_schedule"></a> cleanup_scheduleThe scheduling expression. (e.g. cron(0 20 * * ? *) or rate(5 minutes)string"cron(05 19 * * ? *)"no
<a name="input_instance_id"></a> instance_idAWS Instance ID which is used for creating the AMI image (e.g. id-123456789012)anyn/ayes
<a name="input_name"></a> nameName (e.g. bastion or db)string""no
<a name="input_namespace"></a> namespaceNamespace (e.g. cp or cloudposse)string""no
<a name="input_reboot"></a> rebootReboot the machine as part of the snapshot processstring"false"no
<a name="input_region"></a> regionAWS Region where module should operate (e.g. us-east-1)string""no
<a name="input_retention_days"></a> retention_daysIs the number of days you want to keep the backups for (e.g. 14)string"14"no
<a name="input_stage"></a> stageStage (e.g. prod, dev, staging)string""no

Outputs

No outputs.

<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

[!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.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-ami-backup&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

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

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-ami-backup&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-ami-backup&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

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

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-ec2-ami-backup/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-ec2-ami-backup&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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 <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-ami-backup&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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

<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" alt="License: MIT"></a>

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.

Copyrights

Copyright Β© 2016-2024 Chef Software, Inc

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-ami-backup&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ec2-ami-backup?pixel&cs=github&cm=readme&an=terraform-aws-ec2-ami-backup"/>