forked from chef-boneyard/lambda_ebs_snapshot
-
-
Notifications
You must be signed in to change notification settings - Fork 29
/
README.yaml
120 lines (99 loc) · 3.59 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#
# 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: []