You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The **aws-terraform-scheduled-ec2-ami-backup-automation** module is a customizable Terraform solution designed to automate scheduled backups of Amazon EC2 instances, providing a seamless way to safeguard your data and system configurations. This module simplifies the process of creating and managing automated backup workflows for your EC2 resources, ensuring data resilience and streamlined disaster recovery.
5
+
The **terraform-aws-scheduled-ec2-ami-backup-automation** module is a customizable Terraform solution designed to automate scheduled backups of Amazon EC2 instances, providing a seamless way to safeguard your data and system configurations. This module simplifies the process of creating and managing automated backup workflows for your EC2 resources, ensuring data resilience and streamlined disaster recovery.
6
6
7
7
## Purpose
8
8
9
-
Managing regular backups of your Amazon EC2 instances is a critical aspect of maintaining data integrity and system availability. However, setting up and managing these backups can be complex and time-consuming. The **aws-terraform-scheduled-ec2-ami-backup-automation** module streamlines this process by offering a versatile and configurable solution that allows you to:
9
+
Managing regular backups of your Amazon EC2 instances is a critical aspect of maintaining data integrity and system availability. However, setting up and managing these backups can be complex and time-consuming. The **terraform-aws-scheduled-ec2-ami-backup-automation** module streamlines this process by offering a versatile and configurable solution that allows you to:
10
10
11
11
- Automate the creation of Amazon Machine Images (AMIs) and associated snapshots at scheduled intervals.
12
12
- Specify backup retention policies to control the number of days AMIs and snapshots are retained.
@@ -18,12 +18,12 @@ With its user-friendly configuration and seamless integration into your existing
18
18
19
19
## Module Usage
20
20
21
-
To incorporate the **aws-terraform-scheduled-ec2-ami-backup-automation** module into your Terraform infrastructure, follow these steps:
21
+
To incorporate the **terraform-aws-scheduled-ec2-ami-backup-automation** module into your Terraform infrastructure, follow these steps:
22
22
23
23
-**Module Configuration:** Specify the module configuration by utilizing the module block.
@@ -44,21 +44,21 @@ By following these steps, you can easily integrate the module into your Terrafor
44
44
45
45
## Dependencies and Prerequisites
46
46
47
-
Before you begin using the **aws-terraform-scheduled-ec2-ami-backup-automation** module, ensure that you have the following dependencies and prerequisites in place:
47
+
Before you begin using the **terraform-aws-scheduled-ec2-ami-backup-automation** module, ensure that you have the following dependencies and prerequisites in place:
48
48
49
49
1.**Terraform Installed:** Ensure you have Terraform installed on your local machine or the environment where you intend to use this module. You can download and install Terraform from the official [Terraform website](https://www.terraform.io/downloads.html).
50
50
2.**AWS Credentials:** To deploy resources using this module, you need valid AWS credentials configured on your system. Ensure you have AWS access key and secret key information set up either through environment variables, the AWS CLI configuration, or an AWS credentials file.
51
51
3.**IAM Permissions:** Make sure that the AWS IAM user or role associated with your credentials has the necessary permissions to create and manage EC2 instances, Lambda functions, CloudWatch Events, and related resources.
52
52
53
53
## Example Module Usage
54
54
55
-
To illustrate how the **aws-terraform-scheduled-ec2-ami-backup-automation** module can be used, consider the following example:
55
+
To illustrate how the **terraform-aws-scheduled-ec2-ami-backup-automation** module can be used, consider the following example:
56
56
57
57
Suppose you want to create a scheduled backup solution for your production EC2 instances in the `us-east-1` region. You want to back up instances with the `Backup-AZ-A` tag and retain the backups for `7 days`. The backups should be scheduled to occur at `8:00pm UTC daily`.
@@ -79,7 +79,7 @@ Adapt this example to fit your environment, tagging strategy, and backup retenti
79
79
80
80
## Expected Variables
81
81
82
-
To effectively configure and utilize the **aws-terraform-scheduled-ec2-ami-backup-automation** module, you need to provide values for the following variables:
82
+
To effectively configure and utilize the **terraform-aws-scheduled-ec2-ami-backup-automation** module, you need to provide values for the following variables:
83
83
84
84
|Variable|Description|
85
85
|---|---|
@@ -94,7 +94,7 @@ To effectively configure and utilize the **aws-terraform-scheduled-ec2-ami-backu
94
94
95
95
## Tagging Guidelines
96
96
97
-
Tagging plays a crucial role in the operation of the **aws-terraform-scheduled-ec2-ami-backup-automation** module. To ensure successful backup automation, follow these guidelines when applying tags to your EC2 instances:
97
+
Tagging plays a crucial role in the operation of the **terraform-aws-scheduled-ec2-ami-backup-automation** module. To ensure successful backup automation, follow these guidelines when applying tags to your EC2 instances:
98
98
99
99
-**Backup Tag:** Specify the tag that will be assigned to EC2 instances you want to include in the backup process. The `backup_tag` variable is used to filter instances for backup. **By default, the tag value is set to "Backup"**. However, you can customize this value to match your tagging strategy.
100
100
-**Tag Value:** For instances that are to be backed up, set the value of the specified `backup_tag` to `yes`. This tag value acts as a signal to the module that the instance should be included in the backup automation process. Instances without this tag value will not be backed up.
@@ -124,7 +124,7 @@ Adapt these expressions to your preferred backup schedule. The `schedule_express
124
124
125
125
## Contributing Guidelines
126
126
127
-
Contributions to the **aws-terraform-scheduled-ec2-ami-backup-automation** module are welcome and encouraged! If you'd like to contribute, please follow these guidelines:
127
+
Contributions to the **terraform-aws-scheduled-ec2-ami-backup-automation** module are welcome and encouraged! If you'd like to contribute, please follow these guidelines:
128
128
129
129
1. Fork the repository to your GitHub account.
130
130
2. Create a new branch for your changes.
@@ -137,6 +137,6 @@ Please ensure that your contributions align with the module's scope and purpose.
137
137
138
138
## License Information
139
139
140
-
The **aws-terraform-scheduled-ec2-ami-backup-automation** module is distributed under the MIT License. Feel free to use and modify this module according to your needs. You can find the complete license text in the LICENSE file.
140
+
The **terraform-aws-scheduled-ec2-ami-backup-automation** module is distributed under the MIT License. Feel free to use and modify this module according to your needs. You can find the complete license text in the LICENSE file.
141
141
142
142
By using this module, you agree to the terms and conditions outlined in the MIT License.
0 commit comments