diff --git a/README.md b/README.md index 9108b2c..f26461f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ ## aws-terraform-codeCommit-s3-backups -Backup your AWS CodeCommit repositories to Amazon S3. +Backup AWS CodeCommit repositories to Amazon S3. (or risk discovering that [deleting an AWS CodeCommit repository is a one-way operation](https://aws.amazon.com/codecommit/faqs/)) ## Module Inputs -This module is designed for a [GitHub source type](https://developer.hashicorp.com/terraform/language/modules/sources#github) but it could be cloned and deployed locally, or from a private registry. - ```hcl module "codecommit-s3-backups" { source = "aws-samples/codecommit-s3-backups/aws" @@ -15,7 +13,7 @@ module "codecommit-s3-backups" { name = "codecommit-s3-backup" } ``` -The `name` will be used in the resource names. +The `name` is used in the resource names (AWS CodeBuild project, IAM Roles, etc). ### Optional Inputs @@ -27,28 +25,22 @@ module "codecommit_s3_backup" { } ``` -`kms_key` is the arn of an existing AWS KMS key. It encrypts the Amazon S3 bucket and Amazon CloudWatch Log group. Your AWS KMS key policy will need to follow [CloudWatch Logs guidance for AWS KMS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) and [CodeBuild guidance for AWS KMS](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up-kms.html). +`kms_key` is the arn of an existing AWS KMS key. It encrypts the Amazon S3 bucket and Amazon CloudWatch Log group. The AWS KMS key policy will need to follow [CloudWatch Logs guidance for AWS KMS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) and [CodeBuild guidance for AWS KMS](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up-kms.html). -`access_logging_bucket` is the arn of your Amazon S3 access logging bucket. +`access_logging_bucket` is the arn of an Amazon S3 access logging bucket. ## Architecture