Skip to content

Commit ab4c739

Browse files
committed
updated respository referrances
1 parent 713ac95 commit ab4c739

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
[![terraform-lint](https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation/actions/workflows/terraform-lint.yml/badge.svg)](https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation/actions/workflows/terraform-lint.yml)
1+
[![terraform-lint](https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation/actions/workflows/terraform-lint.yml/badge.svg)](https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation/actions/workflows/terraform-lint.yml)
22

3-
# aws-terraform-scheduled-ec2-ami-backup-automation
3+
# terraform-aws-scheduled-ec2-ami-backup-automation
44

5-
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.
66

77
## Purpose
88

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:
1010

1111
- Automate the creation of Amazon Machine Images (AMIs) and associated snapshots at scheduled intervals.
1212
- 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
1818

1919
## Module Usage
2020

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:
2222

2323
- **Module Configuration:** Specify the module configuration by utilizing the module block.
2424
```terraform
2525
module "ami_scheduled_backup" {
26-
source = "git::https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation.git?ref=v1.1.0"
26+
source = "git::https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation.git?ref=v1.1.0"
2727
2828
name = var.name
2929
environment = var.environment
@@ -44,21 +44,21 @@ By following these steps, you can easily integrate the module into your Terrafor
4444

4545
## Dependencies and Prerequisites
4646

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:
4848

4949
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).
5050
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.
5151
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.
5252

5353
## Example Module Usage
5454

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:
5656

5757
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`.
5858

5959
```terraform
6060
module "ami_scheduled_backup" {
61-
source = "git::https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation.git?ref=v1.1.0"
61+
source = "git::https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation.git?ref=v1.1.0"
6262
6363
name = "ami-backups-az-a"
6464
environment = "Production"
@@ -79,7 +79,7 @@ Adapt this example to fit your environment, tagging strategy, and backup retenti
7979

8080
## Expected Variables
8181

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:
8383

8484
|Variable|Description|
8585
|---|---|
@@ -94,7 +94,7 @@ To effectively configure and utilize the **aws-terraform-scheduled-ec2-ami-backu
9494

9595
## Tagging Guidelines
9696

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:
9898

9999
- **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.
100100
- **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
124124

125125
## Contributing Guidelines
126126

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:
128128

129129
1. Fork the repository to your GitHub account.
130130
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.
137137

138138
## License Information
139139

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.
141141

142142
By using this module, you agree to the terms and conditions outlined in the MIT License.

lambda/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
},
99
"repository": {
1010
"type": "git",
11-
"url": "git+https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation.git"
11+
"url": "git+https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation.git"
1212
},
1313
"author": "Michael Morley",
1414
"license": "ISC",
1515
"bugs": {
16-
"url": "https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation/issues"
16+
"url": "https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation/issues"
1717
},
18-
"homepage": "https://github.com/mikmorley/aws-terraform-scheduled-ec2-ami-backup-automation#readme",
18+
"homepage": "https://github.com/mikmorley/terraform-aws-scheduled-ec2-ami-backup-automation#readme",
1919
"dependencies": {
2020
"aws-lambda-nodejs-helpers": "^0.3.2",
2121
"aws-sdk": "^2.100.0"

0 commit comments

Comments
 (0)