Merge pull request #2463 from Divya-Vijendra-Girase/divyavg-feature-a…

…mi-recycle-bin New serverless pattern - Lambda Recycle Bin
aws-samples · Nov 15, 2024 · 0120427 · 0120427
2 parents c4fd87a + 3bdfa25
commit 0120427
Show file tree

Hide file tree

Showing 9 changed files with 609 additions and 0 deletions.
diff --git a/ami-recycle-bin/README.md b/ami-recycle-bin/README.md
@@ -0,0 +1,87 @@
+# AMI de-registration with AWS Lambda and retention in Amazon EC2 Recycle Bin
+
+## Description
+
+In this pattern an Amazon EventBridge rule triggers an AWS Lambda function which deregisters an Amazon Machine Image (AMI), deletes the associated snapshot and moves them to the Recycle Bin for retention.
+
+The template creates all the necessary resources including an Amazon EventBridge Rule that triggers the AWS Lambda function once every day. Additionally, Recycle Bin rules for AMI and EBS Snapshots are created to retain deleted resources matching the resources for a retention period.
+
+The AWS Lambda function automates the expiration of Amazon Machine Images (AMIs) by moving the AMIs and their associated snapshots to Recycle Bin. Recycle Bin is a feature of Amazon Elastic Compute Cloud (EC2) that allows you to retain AMIs that you have de-registered for a specified retention period, providing an opportunity to recover them if needed. To recover the deleted AMI, its associated snapshot should be recovered first. The Lambda function also adds corresponding tags to both, the AMI and the EBS snapshot, before moving them to Recycle Bin.
+
+
+Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/ami-recycle-bin
+
+Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
+
+## Requirements
+
+* [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
+* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) installed and configured
+* [Git Installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+* [Terraform Installed](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) Required Terraform version >= 4.61.0
+
+## Pre-requisite for Testing
+An AMI to deregister that has the following Tags:
+
+| Key    | Value |
+| -------- | ------- |
+| Expire-After  | Date in Zulu format (e.g. 2024-08-30T17:39:00Z)    |
+| Same value as <i>resource_tag_key</i> in <i>src/variables.tf</i> | Same value as <i>resource_tag_value</i> in <i>src/variables.tf</i>     |
+
+
+## Deployment Instructions
+1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:
+    ``` 
+    git clone https://github.com/aws-samples/serverless-patterns
+    ```
+2. Change directory to the pattern directory:
+    ```
+    cd ami-recycle-bin
+    ```
+3. Bootstrap the input variables in the following file that are used in the Terraform configuration
+    ```
+    src/variables.tf
+    ```
+4. Initialize a new or existing Terraform working directory by downloading required provider plugins and modules
+    ```
+    terraform init
+    ```
+5. Create an execution plan that shows the changes Terraform will make to your infrastructure based on the current configuration files
+    ```
+    terraform plan
+    ```
+6. Apply the changes defined in the Terraform configuration to the infrastructure. Provide the prompts as required
+    ```
+    terraform apply
+    ```
+
+## How It Works
+
+Following is the architectural diagram to demonstrate how the pattern works:
+
+![alt text](src/ami-recycle-bin.png)
+
+1. An Amazon Eventbridge rule is configured to run daily (on a schedule) with AWS Lambda function as a target
+2. The Lambda function performs the following:
+- Verifies that Recycle Bin rules matching the `resource_tag_key` and `resource_tag_value` as bootstraped in the `variables.tf` exists
+- Filters AMIs matching the `resource_tag_key` and `resource_tag_value` and contains the `Expire-After` tag
+- Determines whether any of the filtered AMI are expired using the `Expire-After` tag
+- Tags the expired AMI with its Snapshot Id and the associated snapshot with the AMI Id if required for recovery
+- Deprecates the expired AMI and deletes its associated snapshot
+
+## Testing
+
+1. Verify the the expired AMI and its snapshot is retained in the Recycle Bin after deletion
+2. Verify the AMI and its snapshot can be recovered after deletion before the retention period ends
+
+## Cleanup
+ 
+ Delete the resources
+
+```
+terraform destroy
+```
+----
+Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: MIT-0
diff --git a/ami-recycle-bin/ami-recycle-bin.json b/ami-recycle-bin/ami-recycle-bin.json
@@ -0,0 +1,85 @@
+{
+    "title": "AMI de-registration with AWS Lambda and retention in Amazon EC2 Recycle Bin",
+    "description": "This project demonstrates a pattern to deregister and retain expired AMI and its snapshot with AWS Lambda and Amazon EC2 Recycle Bin",
+    "language": "",
+    "level": "200",
+    "framework": "Terraform",
+    "introBox": {
+        "headline": "How it works",
+        "text": [
+            "In this pattern an Amazon EventBridge rule triggers an AWS Lambda function which deregisters an Amazon Machine Image (AMI), deletes the associated snapshot and moves them to the Recycle Bin for retention.",
+            "The AWS Lambda function automates the expiration of Amazon Machine Images (AMIs) by moving the AMIs and their associated snapshots to Recycle Bin. Recycle Bin is a feature of Amazon Elastic Compute Cloud (EC2) that allows you to retain AMIs that you have de-registered for a specified retention period, providing an opportunity to recover them if needed. To recover the deleted AMI, its associated snapshot should be recovered first. The Lambda function also adds corresponding tags to both, the AMI and the EBS snapshot, before moving them to Recycle Bin."
+        ]
+    },
+    "gitHub": {
+        "template": {
+            "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/ami-recycle-bin",
+            "templateURL": "serverless-patterns/ami-recycle-bin",
+            "projectFolder": "ami-recycle-bin",
+            "templateFile": "main.tf"
+        }
+    },
+    "resources": {
+        "bullets": [
+            {
+                "text": "Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin",
+                "link": "https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html"
+            }
+        ]
+    },
+    "deploy": {
+        "text": [
+            "terraform init",
+            "terraform plan",
+            "terraform apply"
+        ]
+    },
+    "testing": {
+        "text": [
+            "See the Github repo for detailed testing instructions."
+        ]
+    },
+    "cleanup": {
+        "text": [
+            "terraform destroy"
+        ]
+    },
+    "authors": [
+        {
+            "name": "Divya Vijendra Girase",
+            "image": "https://avatars.githubusercontent.com/u/172667506?v=4",
+            "bio": "I am a Cloud Infrastructure Architect at AWS and I work with our strategic customers to build, run and maintain their infrastructure on AWS.",
+            "linkedin": "divya-girase"
+        }
+    ],
+    "patternArch": {
+        "icon1": {
+            "x": 20,
+            "y": 50,
+            "service": "eventbridge",
+            "label": "Amazon EventBridge rule"
+        },
+        "icon2": {
+            "x": 50,
+            "y": 50,
+            "service": "lambda",
+            "label": "AWS Lambda"
+        },
+        "icon3": {
+            "x": 80,
+            "y": 50,
+            "service": "ec2",
+            "label": "Amazon EC2"
+        },
+        "line1": {
+            "from": "icon1",
+            "to": "icon2",
+            "label": ""
+        },
+        "line2": {
+            "from": "icon2",
+            "to": "icon3",
+            "label": ""
+        }
+    }
+}
diff --git a/ami-recycle-bin/data.tf b/ami-recycle-bin/data.tf
@@ -0,0 +1,8 @@
+# data source to lookup information about the current AWS partition in which Terraform is working
+data "aws_partition" "current" {}
+
+# data source to get the access to the effective Account ID, User ID, and ARN in which Terraform is authorized
+data "aws_caller_identity" "current" {}
+
+# data source to obtain the name of the AWS region configured on the provider
+data "aws_region" "current" {}
diff --git a/ami-recycle-bin/example-pattern.json b/ami-recycle-bin/example-pattern.json
@@ -0,0 +1,55 @@
+{
+    "title": "AMI de-registration with AWS Lambda and retention in Amazon EC2 Recycle Bin",
+    "description": "This project demonstrates a pattern to deregister and retain expired AMI and its snapshot with AWS Lambda and Amazon EC2 Recycle Bin",
+    "language": "",
+    "level": "200",
+    "framework": "Terraform",
+    "introBox": {
+      "headline": "How it works",
+      "text": [
+        "In this pattern an Amazon EventBridge rule triggers an AWS Lambda function which deregisters an Amazon Machine Image (AMI), deletes the associated snapshot and moves them to the Recycle Bin for retention.",
+        "The AWS Lambda function automates the expiration of Amazon Machine Images (AMIs) by moving the AMIs and their associated snapshots to Recycle Bin. Recycle Bin is a feature of Amazon Elastic Compute Cloud (EC2) that allows you to retain AMIs that you have de-registered for a specified retention period, providing an opportunity to recover them if needed. To recover the deleted AMI, its associated snapshot should be recovered first. The Lambda function also adds corresponding tags to both, the AMI and the EBS snapshot, before moving them to Recycle Bin."
+      ]
+    },
+    "gitHub": {
+      "template": {
+        "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/ami-recycle-bin",
+        "templateURL": "serverless-patterns/ami-recycle-bin",
+        "projectFolder": "ami-recycle-bin",
+        "templateFile": "main.tf"
+      }
+    },
+    "resources": {
+      "bullets": [
+        {
+          "text": "Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin",
+          "link": "https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin.html"
+        }
+      ]
+    },
+      "deploy": {
+          "text": [
+                    "terraform init",
+                    "terraform plan",
+                    "terraform apply"
+                  ]
+      },
+      "testing": {
+          "text": [
+          "See the Github repo for detailed testing instructions."
+          ]
+      },
+      "cleanup": {
+          "text": [
+                    "terraform destroy"
+                  ]
+      },
+      "authors": [
+          {
+              "name": "Divya Vijendra Girase",
+              "image": "https://avatars.githubusercontent.com/u/172667506?v=4",
+              "bio": "I am a Cloud Infrastructure Architect at AWS and I work with our strategic customers to build, run and maintain their infrastructure on AWS.",
+              "linkedin": "divya-girase"
+          }
+      ]
+  }