Terraform Module for CI/CD with AWS Code Pipeline using GitHub webhook triggers and Code Build for ECS.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest, see test.

Trigger on GitHub Push

In this example, we'll trigger the pipeline anytime the master branch is updated.

module "ecs_push_pipeline" {
  source = "cloudposse/ecs-codepipeline/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  name                  = "app"
  namespace             = "eg"
  stage                 = "staging"
  github_oauth_token    = "xxxxxxxxxxxxxx"
  github_webhooks_token = "xxxxxxxxxxxxxx"
  repo_owner            = "cloudposse"
  repo_name             = "example"
  branch                = "master"
  service_name          = "example"
  ecs_cluster_name      = "eg-staging-example-cluster"
  privileged_mode       = "true"
}

Trigger on GitHub Releases

In this example, we'll trigger anytime a new GitHub release is cut by setting the even type to release and using the json_path to exactly match an action of published.

module "ecs_release_pipeline" {
  source = "cloudposse/ecs-codepipeline/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  name                        = "app"
  namespace                   = "eg"
  stage                       = "staging"
  github_oauth_token          = "xxxxxxxxxxxxxx"
  github_webhooks_token       = "xxxxxxxxxxxxxx"
  repo_owner                  = "cloudposse"
  repo_name                   = "example"
  branch                      = "master"
  service_name                = "example"
  ecs_cluster_name            = "eg-staging-example-cluster"
  privileged_mode             = "true"
  github_webhook_events       = ["release"]
  webhook_filter_json_path    = "$.action"
  webhook_filter_match_equals = "published"
}

(Thanks to Stack Overflow)

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Examples

Complete usage can be seen in the terraform-aws-ecs-web-app module.

Example Buildspec

Here's an example buildspec.yaml. Stick this in the root of your project repository.

version: 0.2
phases:
  pre_build:
    commands:
      - echo Logging in to Amazon ECR...
      - aws --version
      - eval $(aws ecr get-login --region $AWS_DEFAULT_REGION --no-include-email)
      - REPOSITORY_URI=$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$IMAGE_REPO_NAME
      - IMAGE_TAG=$(echo $CODEBUILD_RESOLVED_SOURCE_VERSION | cut -c 1-7)
  build:
    commands:
      - echo Build started on `date`
      - echo Building the Docker image...
      - REPO_URI=$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$IMAGE_REPO_NAME
      - docker pull $REPO_URI:latest || true
      - docker build --cache-from $REPO_URI:latest --tag $REPO_URI:latest --tag $REPO_URI:$IMAGE_TAG .
  post_build:
    commands:
      - echo Build completed on `date`
      - echo Pushing the Docker images...
      - REPO_URI=$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$IMAGE_REPO_NAME
      - docker push $REPO_URI:latest
      - docker push $REPO_URI:$IMAGE_TAG
      - echo Writing image definitions file...
      - printf '[{"name":"%s","imageUri":"%s"}]' "$CONTAINER_NAME" "$REPO_URI:$IMAGE_TAG" | tee imagedefinitions.json
artifacts:
  files: imagedefinitions.json

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen

Requirements

Name	Version
terraform	>= 1.3
aws	>= 5.0
random	>= 2.1

Providers

Name	Version
aws	>= 5.0
random	>= 2.1

Modules

Name	Source	Version
codebuild	cloudposse/codebuild/aws	2.0.2
codebuild_label	cloudposse/label/null	0.25.0
codepipeline_assume_role_label	cloudposse/label/null	0.25.0
codepipeline_label	cloudposse/label/null	0.25.0
codepipeline_s3_policy_label	cloudposse/label/null	0.25.0
codestar_label	cloudposse/label/null	0.25.0
github_webhooks	cloudposse/repository-webhooks/github	0.14.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_codepipeline.bitbucket	resource
aws_codepipeline.default	resource
aws_codepipeline_webhook.webhook	resource
aws_iam_policy.codebuild	resource
aws_iam_policy.codestar	resource
aws_iam_policy.default	resource
aws_iam_policy.s3	resource
aws_iam_role.default	resource
aws_iam_role_policy_attachment.codebuild	resource
aws_iam_role_policy_attachment.codebuild_codestar	resource
aws_iam_role_policy_attachment.codebuild_extras	resource
aws_iam_role_policy_attachment.codebuild_s3	resource
aws_iam_role_policy_attachment.codestar	resource
aws_iam_role_policy_attachment.default	resource
aws_iam_role_policy_attachment.s3	resource
aws_s3_bucket.default	resource
random_string.webhook_secret	resource
aws_caller_identity.default	data source
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.codebuild	data source
aws_iam_policy_document.codestar	data source
aws_iam_policy_document.default	data source
aws_iam_policy_document.s3	data source
aws_region.default	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the `delimiter` and treated as a single ID element.	`list(string)`	`[]`	no
aws_account_id	AWS Account ID. Used as CodeBuild ENV variable when building Docker images. For more info	`string`	`""`	no
badge_enabled	Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled	`bool`	`false`	no
branch	Branch of the GitHub repository, e.g. `master`	`string`	n/a	yes
build_compute_type	`CodeBuild` instance size. Possible values are: `BUILD_GENERAL1_SMALL` `BUILD_GENERAL1_MEDIUM` `BUILD_GENERAL1_LARGE`	`string`	`"BUILD_GENERAL1_SMALL"`	no
build_image	Docker image for build environment, https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html	`string`	`"aws/codebuild/amazonlinux2-x86_64-standard:5.0"`	no
build_timeout	How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed	`number`	`60`	no
build_type	The type of build environment, e.g. 'LINUX_CONTAINER' or 'WINDOWS_CONTAINER' or 'ARM_CONTAINER'	`string`	`"LINUX_CONTAINER"`	no
buildspec	Declaration to use for building the project. For more info	`string`	`""`	no
cache_bucket_suffix_enabled	The cache bucket generates a random 13 character string to generate a unique bucket name. If set to false it uses terraform-null-label's id value. It only works when cache_type is 'S3'	`bool`	`true`	no
cache_type	The type of storage that will be used for the AWS CodeBuild project cache. Valid values: NO_CACHE, LOCAL, and S3. Defaults to S3. If cache_type is S3, it will create an S3 bucket for storing codebuild cache inside	`string`	`"S3"`	no
codebuild_extra_policy_arns	List of ARNs of extra policies to attach to the CodeBuild role	`list(string)`	`[]`	no
codebuild_vpc_config	Configuration for the builds to run inside a VPC.	`any`	`{}`	no
codestar_connection_arn	CodeStar connection ARN required for Bitbucket integration with CodePipeline	`string`	`""`	no
codestar_output_artifact_format	Output artifact type for Source stage in pipeline. Valid values are "CODE_ZIP" (default) and "CODEBUILD_CLONE_REF". See https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html	`string`	`"CODE_ZIP"`	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as `null` to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	`any`	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{<br/> format = string<br/> labels = list(string)<br/>}` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. `labels` is a list of labels, in order, to pass to `format()` function. Label values will be normalized before being passed to `format()` so they will be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
ecs_cluster_name	ECS Cluster Name	`string`	n/a	yes
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
environment_variables	A list of maps, that contain the keys 'name', 'value', and 'type' to be used as additional environment variables for the build. Valid types are 'PLAINTEXT', 'PARAMETER_STORE', or 'SECRETS_MANAGER'	list(object( { name = string value = string type = string }))	`[]`	no
github_oauth_token	GitHub OAuth Token with permissions to access private repositories	`string`	`""`	no
github_webhook_events	A list of events which should trigger the webhook. See a list of available events	`list(string)`	[ "push" ]	no
id_length_limit	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for keep the existing setting, which defaults to `0`. Does not affect `id_full`.	`number`	`null`	no
image_repo_name	ECR repository name to store the Docker image built by this module. Used as CodeBuild ENV variable when building Docker images. For more info	`string`	n/a	yes
image_tag	Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable when building Docker images. For more info	`string`	`"latest"`	no
label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper`. Default value: `title`.	`string`	`null`	no
label_order	The order in which the labels (ID elements) appear in the `id`. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
label_value_case	Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. Does not affect values of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper` and `none` (no transformation). Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. Default value: `lower`.	`string`	`null`	no
labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output. Default is to include all labels. Tags with empty values will not be included in the `tags` output. Set to `[]` to suppress all generated tags. Notes: The value of the `name` tag, if included, will be the `id`, not the `name`. Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	no
local_cache_modes	Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: LOCAL_SOURCE_CACHE, LOCAL_DOCKER_LAYER_CACHE, and LOCAL_CUSTOM_CACHE	`list(string)`	`[]`	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a `tag`. The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
poll_source_changes	Periodically check the location of your source content and run the pipeline if changes are detected	`bool`	`false`	no
privileged_mode	If set to true, enables running the Docker daemon inside a Docker container on the CodeBuild instance. Used when building Docker images	`bool`	`false`	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
region	AWS Region, e.g. us-east-1. Used as CodeBuild ENV variable when building Docker images. For more info	`string`	n/a	yes
repo_name	GitHub repository name of the application to be built and deployed to ECS	`string`	n/a	yes
repo_owner	GitHub Organization or Username	`string`	n/a	yes
s3_bucket_force_destroy	A boolean that indicates all objects should be deleted from the CodePipeline artifact store S3 bucket so that the bucket can be destroyed without error	`bool`	`false`	no
secondary_artifact_bucket_id	Optional bucket for secondary artifact deployment. If specified, the buildspec must include a secondary artifacts section which controls the artifacts deployed to the bucket For more info	`string`	`null`	no
secondary_artifact_encryption_enabled	If set to true, enable encryption on the secondary artifact bucket	`bool`	`false`	no
secondary_artifact_identifier	Identifier for optional secondary artifact deployment. If specified, the identifier must appear in the buildspec as the name of the section which controls the artifacts deployed to the secondary artifact bucket For more info	`string`	`null`	no
service_name	ECS Service Name	`string`	n/a	yes
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
webhook_authentication	The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED	`string`	`"GITHUB_HMAC"`	no
webhook_enabled	Set to false to prevent the module from creating any webhook resources	`bool`	`true`	no
webhook_filter_json_path	The JSON path to filter on	`string`	`"$.ref"`	no
webhook_filter_match_equals	The value to match on (e.g. refs/heads/{Branch})	`string`	`"refs/heads/{Branch}"`	no
webhook_target_action	The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline	`string`	`"Source"`	no

Outputs

Name	Description
badge_url	The URL of the build badge when badge_enabled is enabled
codebuild_badge_url	The URL of the build badge when badge_enabled is enabled
codebuild_cache_bucket_arn	CodeBuild cache S3 bucket ARN
codebuild_cache_bucket_name	CodeBuild cache S3 bucket name
codebuild_project_id	CodeBuild project ID
codebuild_project_name	CodeBuild project name
codebuild_role_arn	CodeBuild IAM Role ARN
codebuild_role_id	CodeBuild IAM Role ID
codepipeline_arn	CodePipeline ARN
codepipeline_id	CodePipeline ID
codepipeline_resource	CodePipeline resource
webhook_id	The CodePipeline webhook's ID
webhook_url	The CodePipeline webhook's URL. POST events to this endpoint to trigger the target

Related Projects

Check out these related projects.

terraform-aws-alb - Terraform module to provision a standard ALB for HTTP/HTTP traffic
terraform-aws-alb-ingress - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB
terraform-aws-codebuild - Terraform Module to easily leverage AWS CodeBuild for Continuous Integration
terraform-aws-ecr - Terraform Module to manage Docker Container Registries on AWS ECR
terraform-aws-ecs-alb-service-task - Terraform module which implements an ECS service which exposes a web service via ALB.
terraform-aws-ecs-container-definition - Terraform module to generate well-formed JSON documents that are passed to the aws_ecs_task_definition Terraform resource
terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs.

References

For additional context, refer to some of these links.

aws_codepipeline_webhook - Provides a CodePipeline Webhook

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

👽 Use Atmos with Terraform

Usage

Trigger on GitHub Push

Trigger on GitHub Releases

Examples

Example Buildspec

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Related Projects

References

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

✨ Contributing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks

Files

README.md

Latest commit

History

README.md

File metadata and controls

👽 Use Atmos with Terraform

Usage

Trigger on GitHub Push

Trigger on GitHub Releases

Examples

Example Buildspec

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Related Projects

References

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

✨ Contributing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks