AWS CodeCommit to S3

This pattern implements the solution outlined on the "Automate event-driven backups from CodeCommit to Amazon S3 using CodeBuild and CloudWatch Events" Presciptive Guidance.

Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/codecomit-s3.

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 for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

• Create an AWS account 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 installed and configured
• Git Installed
• AWS Serverless Application Model (AWS SAM) installed

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 codecommit-s3
   

3. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:

   sam deploy --guided  --capabilities CAPABILITY_NAMED_IAM
   

4. During the prompts:

   • Enter a stack name
   • Enter the desired AWS Region
   • Allow SAM CLI to create IAM roles with the required permissions.

   Once you have run sam deploy --guided mode once and saved arguments to a configuration file (samconfig.toml), you can use sam deploy in future to use these defaults.

5. Note the outputs from the SAM deployment process. These contain the resource names and/or ARNs which are used for testing.

How it works

When the content of a CodeCommit repository is modified (for example, by a git push command), it notifies EventBridge of the repository change. EventBridge then invokes AWS CodeBuild with the CodeCommit repository information. CodeBuild clones the entire CodeCommit repository, packages it into a .zip file and uploads the it to an S3 bucket. During deployment, the pattern uses a Lambda function and a CloudFormation Custom Resource to create the CodeBuild's buildspec.yml template.

Testing

1. Create or use a pre-existing CodeCommit repository
2. Update the repository content
3. Verify that the zip file is created on the backup bucket, under the folder repositories

Cleanup

1. Delete the stack

   aws cloudformation delete-stack --stack-name STACK_NAME

2. Confirm the stack has been deleted

   aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"

---

Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0