README.yaml

name: terraform-aws-codebuild
tags:
  - aws
  - terraform
  - terraform-modules
  - cicd
  - codepipeline
  - codebuild
  - continuous-integration
  - continuous-delivery
categories:
  - terraform-modules/cicd
license: APACHE2
github_repo: cloudposse/terraform-aws-codebuild
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-codebuild.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-codebuild/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-codebuild.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-codebuild/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: terraform-aws-ecs-codepipeline
    description: Terraform Module for CI/CD with AWS Code Pipeline and Code Build for ECS
    url: https://github.com/cloudposse/terraform-aws-ecs-codepipeline
description: Terraform module to create AWS CodeBuild project for AWS CodePipeline.
usage: |-
  Include this module in your existing terraform code:

  ```hcl
  module "build" {
    source = "cloudposse/codebuild/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    namespace           = "eg"
    stage               = "staging"
    name                = "app"

    # https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
    build_image         = "aws/codebuild/standard:2.0"
    build_compute_type  = "BUILD_GENERAL1_SMALL"
    build_timeout       = 60

    # These attributes are optional, used as ENV variables when building Docker images and pushing them to ECR
    # For more info:
    # http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html
    # https://www.terraform.io/docs/providers/aws/r/codebuild_project.html

    privileged_mode     = true
    aws_region          = "us-east-1"
    aws_account_id      = "xxxxxxxxxx"
    image_repo_name     = "ecr-repo-name"
    image_tag           = "latest"

    # Optional extra environment variables
    environment_variables = [
      {
        name  = "JENKINS_URL"
        value = "https://jenkins.example.com"
        type  = "PLAINTEXT"
      },
      {
        name  = "COMPANY_NAME"
        value = "Amazon"
        type  = "PLAINTEXT"
      },
      {
        name = "TIME_ZONE"
        value = "Pacific/Auckland"
        type  = "PLAINTEXT"
      }
    ]
  }
  ```

include:
  - docs/targets.md
  - docs/terraform.md
contributors: []