## AWS Cloudformation Publisher
AWS CloudFormation Publisher packages your CloudFormation templates into an S3 bucket in every AWS region and creates "launch stack" links that you can use in your documentation so that your customers can easily launch stacks in their AWS accounts from your CloudFormation templates.
## Overview
AWS CloudFormation Publisher packages your CloudFormation templates into an S3 bucket in every AWS region through a CodeBuild project which, when you start a build, can be overridden to point at your project's source location.
AWS CloudFormation Publisher creates S3 buckets for each region in your account. The bucket names have the following format:
`${bucket prefix}-{region name}`
For example: `cfn-0123456789012-us-east-1`
Your projects' CloudFormation templates will be stored as `{project name}/{version}/{template}`.
## Installation
To deploy, launch the AWS Cloudformation Publisher into your account:
|Region|Launch Template|
|------|---------------|
|**US East (N. Virginia)** (us-east-1) | [](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-us-east-1.s3.us-east-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**US East (Ohio)** (us-east-2) | [](https://console.aws.amazon.com/cloudformation/home?region=us-east-2#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-us-east-2.s3.us-east-2.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**US West (Oregon)** (us-west-2) | [](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-us-west-2.s3.us-west-2.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**EU (Ireland)** (eu-west-1) | [](https://console.aws.amazon.com/cloudformation/home?region=eu-west-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-eu-west-1.s3.eu-west-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Tokyo)** (ap-northeast-1) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-northeast-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-northeast-1.s3.ap-northeast-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Sydney)** (ap-southeast-2) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-southeast-2#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-southeast-2.s3.ap-southeast-2.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
More regions
|Region|Launch Template|
|------|---------------|
|**US West (N. California)** (us-west-1) | [](https://console.aws.amazon.com/cloudformation/home?region=us-west-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-us-west-1.s3.us-west-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Hong Kong)** (ap-east-1) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-east-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-east-1.s3.ap-east-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Mumbai)** (ap-south-1) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-south-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-south-1.s3.ap-south-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Seoul)** (ap-northeast-2) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-northeast-2#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Asia Pacific (Singapore)** (ap-southeast-1) | [](https://console.aws.amazon.com/cloudformation/home?region=ap-south-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ap-southeast-1.s3.ap-southeast-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**Canada (Central)** (ca-central-1) | [](https://console.aws.amazon.com/cloudformation/home?region=ca-central-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-ca-central-1.s3.ca-central-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**EU (London)** (eu-west-2) | [](https://console.aws.amazon.com/cloudformation/home?region=eu-west-2#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-eu-west-2.s3.eu-west-2.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**EU (Frankfurt)** (eu-west-3) | [](https://console.aws.amazon.com/cloudformation/home?region=eu-west-3#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-eu-west-3.s3.eu-west-3.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**EU (Stockholm)** (eu-north-1) | [](https://console.aws.amazon.com/cloudformation/home?region=eu-north-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-eu-north-1.s3.eu-north-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
|**South America (Sao Paulo)** (sa-east-1) | [](https://console.aws.amazon.com/cloudformation/home?region=sa-east-1#/stacks/new?stackName=aws-cloudformation-publisher&templateURL=https://solution-builders-sa-east-1.s3.sa-east-1.amazonaws.com/aws-cloudformation-publisher/latest/cfn.template)|
This will create a CodeBuild project named `cfn-publish` in your account.
## Configuration
AWS CloudFormation Publisher looks for a file in the root of your repository called `cfn-publish.config` which can be used to override:
* The location of the CloudFormation template(s) in the repository that you wish to publish (the default is a single template called `cfn.template`)
* The regions to publish to (the default is all regions)
* The prefix to use in bucket names (the default is `cfn-`)
* The ACL to use for uploaded artefacts (the default is `private` i.e. only IAM principals in your account who have explicitly been granted access to the bucket can launch the template)
* The project name to prefix all artefact object keys with in S3 (if using a git source, the default is the repo name. if using an S3 object source, the default is file name, without it's extension)
Your `cfn-publish.config`, if you need one, should look something like this:
```
templates="first.template second.template"
regions="eu-west-1 eu-west-2 eu-central-1"
bucket_name_prefix="my-custom-prefix"
acl="private"
project="my-project"
extra_files="backend.zip frontend.zip"
```
## Usage
To publish your repository's CloudFormation templates, take the following steps:
* Open the [CodeBuild console](https://console.aws.amazon.com/codesuite/codebuild/projects/)
* Select the `cfn-publish` project
* Press "Start Build"
* Press "Advanced build overrides"
* Configure the "Source" section
* Press "Start build"
You will see the S3 bucket and output CloudFormation template names in the build output.
## Notifications
An SNS topic is created as part of the solution which you can subscribe to in order to receive
notifications regarding publisher execution statuses. Notifications will be in the format:
```
Publication of '' has reached the status ''
```
## Versioning
The publisher will look for the environment variable VERSION to determine which version to use in the object key. If the VERSION is set, templates from the **most recent** execution will be available at both `{project name}/{version}/{template}` and `{project name}/latest/{template}`. If the VERSION is not set, then templates will only be published at `{project name}/latest/{template}`.
Before publishing a version, the publisher will first wipe any existing files it finds for that version from the S3 buckets.
## Contributing
Contributions are more than welcome. Please read the [code of conduct](CODE_OF_CONDUCT.md) and the [contributing guidelines](CONTRIBUTING.md).
## License Summary
This sample code is made available under the MIT-0 license. See the LICENSE file.