All Quick Starts include parameters with sensible default settings. You can change the defaults to customize your deployment; for example, you can change the network configuration, choose different instance types, and customize the configuration of cloud resources.
If you’d like to make more significant changes or use the Quick Start templates as a starting point for your own deployment project, you can download the templates and customize or extend them for your specific requirements. Most of the Quick Starts include portability parameters that help you update code references automatically. Follow these steps:
Connect to GitHub with SSH. The Quick Starts use Git submodules, which are set up with Git URLs. To clone the repository successfully, you must use GitHub SSH authentication. See the Github documentation for details.
Download the source code for the Quick Start from https://github.com/aws-quickstart/. You can find the repository by searching for the Quick Start name, and then clone it recursively to initialize and pull all the submodules referenced in the Quick Start:
git clone --recursive email@example.com:aws-quickstart/<repo-name>.git
For example, to clone the repository for the Microsoft Exchange Quick Start:
git clone --recursive firstname.lastname@example.org:aws-quickstart/quickstart-microsoft-exchange.git
- Copy the templates and scripts to your own S3 bucket (public or private).
- Revise the templates and scripts for your use case. The AWS CloudFormation code and best practices are discussed in the Quick Start builder’s guide.
- Test your templates. Testing tools and techniques are discussed in the Quick Start tester’s guide.
- Launch the Quick Start template from the new S3 location by specifying the new template URL in the AWS CloudFormation console or API.
- In the AWS CloudFormation console, change the settings of these two parameters to automatically update code references to point to your new location:
- Quick Start S3 Bucket Name (QSS3BucketName): Set this to your new S3 bucket name.
- Quick Start S3 Key Prefix (QSS3KeyPrefix): Set this to the location of the Quick Start code files in your S3 bucket.
If you’re launching the template from the AWS CloudFormation API, be sure to set these two parameters in the CreateStack call.
We also encourage you to share your customizations with other users by contributing to the Quick Start GitHub repos.