This guide provides information about building a Quick Start and working with the AWS Quick Start team to get it published. It also includes detailed guidelines for developing your Quick Start template and testing it, based on best practices developed by solutions architects on the AWS Quick Start team.
How to contribute
If you’re interested in building a Quick Start, the Amazon Web Services (AWS) Quick Start team will work with you to get it published on the AWS website (https://aws.amazon.com/quickstart/). Follow these steps:
Take a look at current Quick Starts. Decide whether a Quick Start or an Amazon Machine Image (AMI) in the AWS Marketplace is a better option for deploying your technology on AWS. For more information, see the Quick Start FAQ.
Talk to your Partner Development Manager or Partner Solution Architect at AWS, or contact firstname.lastname@example.org about your Quick Start proposal. A brief spec for your deployment and/or an architectural diagram will help us determine if and when your Quick Start fits on the roadmap.
If your project is approved, we will schedule a kick-off meeting to discuss commitments and timeline for development, documentation, testing, and launch. Allow 45 days from acceptance to launch.
Your Quick Start must include, at the minimum:
- A path to partner media or AMI used by the Quick Start
- An AWS CloudFormation template that automates the deployment
- Explanation of deployment architecture and steps
- A license that allows us to distribute the template (Apache 2.0)
- An SLA to maintain and support the Quick Start, or an expiration date for the Quick Start
For detailed guidelines on building and testing your template, see the subsequent sections of this guide.
AWS launch activities include:
- What’s new page on the AWS website (example)
- Social media (Facebook, Twitter, LinkedIn, Google+)
- AWS internal announcement
- Announcement on the Quick Start forum
- Optional blog post (e.g., APN blog or Jeff Barr’s blog)
The launch includes:
- Quick Start templates in the Quick Start S3 bucket and in GitHub
- Quick Start landing page (example) and deployment guide (example)
- Links from Quick Start homepage, marketing pages, and APN portal
- Plan for proactive updates
- Respond to user queries and fix bugs
- Have a well-defined support path or contact person for issues
- Obsess over your customers and iterate quickly on feedback
If you have any questions, contact us at email@example.com.
Quick Start checklist
Here’s a quick list that you can use to check off your development tasks:
Complete the prerequisites listed in the Before you get started section.
Work with us to set up a Git repo for your Quick Start files.
Visualize your Quick Start architecture by creating an architecture diagram.
Build your Quick Start templates:
- Design your code
- Use existing AMIs
- Design template parameters
- Follow best practices
- Add Quick Start IDs
Create a parameters file for automated testing.
Create a deployment guide with architecture and step-by-step instructions.
AWS CloudFormation checklist
Quick Starts are designed for both trial and production use, so your AWS CloudFormation templates should incorporate AWS best practices. If you’re unable to meet the following requirements, contact us to discuss your exception case.
Multi-AZ architecture (details)
Support for the majority of AWS Regions (details)
New VPC and existing VPC deployment options (details)
Product instances in private subnets (details)
NAT gateways for outbound Internet access from private subnets (details)
Marketplace AMIs whenever possible; no prebaked AMIs (details)
AMI mappings; no hardcoded AMIs (details)
User-friendly parameter labels and groups (details)
CIDR block lockdown for external admin access (details)
Security groups with principle of least privilege (details)
No software bits with deployment (details)
No hardcoded passwords (details)
No sensitive data in EC2 instance user data or other clear text (details)
No use of 0.0.0.0/0 for open remote management access (details)
No resources created automatically outside stack (details)