Menu
AWS CodeDeploy
User Guide (API Version 2014-10-06)

AWS CloudFormation Templates for AWS CodeDeploy Reference

In addition to the other methods available to you in AWS CodeDeploy, you can use AWS CloudFormation templates to perform the following tasks:

  • Create applications.

  • Create deployment groups and specify a target revision.

  • Create deployment configurations.

  • Create Amazon EC2 instances.

AWS CloudFormation is a service that helps you model and set up your AWS resources using templates. An AWS CloudFormation template is a text file whose format complies with the JSON standard. You create a template that describes all of the AWS resources you want, and AWS CloudFormation takes care of provisioning and configuring those resources for you.

For more information, see What Is AWS CloudFormation? and Working with AWS CloudFormation Templates in AWS CloudFormation User Guide.

If you plan to use AWS CloudFormation templates that are compatible with AWS CodeDeploy in your organization, as an administrator, you must grant access to AWS CloudFormation and to the AWS services and actions on which AWS CloudFormation depends. To grant permissions to create applications, deployment groups, and deployment configurations, attach the following policy to the IAM users who will work with AWS CloudFormation:

Copy
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudformation:*" ], "Resource": "*" } ] }

For more information about managed policies, see the following topics:

The following table shows the actions an AWS CloudFormation template can perform on your behalf and includes links to more information about the AWS resource types and their property types you can add to an AWS CloudFormation template.

Action AWS CloudFormation Resource Type
Create an AWS CodeDeploy application. AWS::CodeDeploy::Application
Create and specify the details for a deployment group to be used to deploy your application revisions. ¹ AWS::CodeDeploy::DeploymentGroup
Create a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy will use during a deployment. AWS::CodeDeploy::DeploymentConfig
Create an Amazon EC2 instance. ² AWS::EC2::Instance

¹ If you specify the version of the application revision that you want to be deployed as part of the deployment group, your target revision will be deployed as soon as the provisioning process is complete. For more information about template configuration, see AWS CodeDeploy DeploymentGroup Deployment Revision S3Location and AWS CodeDeploy DeploymentGroup Deployment Revision GitHubLocation in the AWS CloudFormation User Guide.

² We provide templates you can use to create Amazon EC2 instances in the regions in which AWS CodeDeploy is supported. For more information about using these templates, see Create an Amazon EC2 Instance (AWS CloudFormation Template).