README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-ec2-ami-backup

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - backups
  - aws-lambda
  - ami
  - scheduled-events
  - cronjob
  - snapshot
  - ebs

# Categories of this project
categories:
  - terraform-modules/backups

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "MIT"

copyrights:
  - name: "Chef Software, Inc"
    url: "https://www.chef.io/"
    year: "2016"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-ec2-ami-backup

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-ami-backup.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ec2-ami-backup/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-ami-backup.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ec2-ami-backup/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-ec2-ami-snapshot"
    description: "Terraform module to easily generate AMI snapshots to create replica instances"
    url: "https://github.com/cloudposse/terraform-aws-ec2-ami-snapshot"
  - name: "terraform-aws-efs-backup"
    description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline"
    url: "https://github.com/cloudposse/terraform-aws-efs-backup"

    
# Short description of this project
description: |-
  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/>.

# How to use this project
usage: |-
  Include this repository as a module in your existing terraform code:

  ```hcl
  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"
  }
  ```

examples: |-
  Example on excluding some of attached EBS volumes:

  ```hcl
  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" = "" },
    ]
  }
  ```

references:
  - name: "Terraform config for automatic EBS snapshots"
    description: "This repo contains a terraform configuration that creates two lambda functions that will take automatic EBS snapshots at regular intervals."
    url: "https://github.com/chef/lambda_ebs_snapshot"

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []