Contents

---
title: Type Option
nav_order: 4
---

The `--type` option is a powerful option that allows you to create multiple codebuild projects associated with the same project.

## Default Behavior

By default, the codebuild tool looks up files in the `.codebuild` folder.  Example:

    .codebuild/buildspec.yml
    .codebuild/project.rb
    .codebuild/role.rb

You can affect the behavior of the lookup logic with the `--type` option.

## Examples

    cb deploy --type deploy

This will look up buildspec.yml, project.rb, and role.rb files in the `.codebuild/deploy` folder. So:

    .codebuild/deploy/buildspec.yml
    .codebuild/deploy/project.rb
    .codebuild/deploy/role.rb

Likewise `cb deploy --type unit` would result in:

    .codebuild/unit/buildspec.yml
    .codebuild/unit/project.rb
    .codebuild/unit/role.rb

## Structure

So if you need multiple CodeBuild projects that perform different tasks but are both related to the same code repo, this structure is useful:

    .codebuild
    ├── deploy
    │   ├── buildspec.yml
    │   ├── project.rb
    │   ├── role.rb
    │   └── schedule.rb
    └── unit
        ├── buildspec.yml
        ├── project.rb
        ├── role.rb
        └── schedule.rb

## Code Project Name

The CloudFormation stack name is appended with the name of the type option. So if your project folder is `demo` and the type option is `unit`.

    cd demo # project folder
    cb deploy --type unit

It produces a CodeBuild project named `demo-unit`.  The project name is an optional first CLI argument. Here's an example:

    cd demo # project folder
    cb deploy demo-web --type deploy # CodeProject name: demo-web-deploy

## Stack Name

The stack name is the same as the CodeBuild project name with the `-cb` suffix appended to it.  Examples:

CodeBuild Project Name | Stack Name
--- | ---
demo | demo-cb
demo-unit | demo-unit-cb
demo-web-unit | demo-web-unit-cb

{% include prev_next.md %}

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
codebuild-0.6.2	docs/_docs/type-option.md
codebuild-0.6.1	docs/_docs/type-option.md
codebuild-0.6.0	docs/_docs/type-option.md