Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . codebuild ]

create-project

Description

Creates a build project.

See also: AWS API Documentation

Synopsis

  create-project
--name <value>
[--description <value>]
--source <value>
--artifacts <value>
--environment <value>
[--service-role <value>]
[--timeout-in-minutes <value>]
[--encryption-key <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the build project.

--description (string)

A description that makes the build project easy to identify.

--source (structure)

Information about the build input source code for the build project.

Shorthand Syntax:

type=string,location=string,buildspec=string,auth={type=string,resource=string}

JSON Syntax:

{
  "type": "CODECOMMIT"|"CODEPIPELINE"|"GITHUB"|"S3"|"BITBUCKET",
  "location": "string",
  "buildspec": "string",
  "auth": {
    "type": "OAUTH",
    "resource": "string"
  }
}

--artifacts (structure)

Information about the build output artifacts for the build project.

Shorthand Syntax:

type=string,location=string,path=string,namespaceType=string,name=string,packaging=string

JSON Syntax:

{
  "type": "CODEPIPELINE"|"S3"|"NO_ARTIFACTS",
  "location": "string",
  "path": "string",
  "namespaceType": "NONE"|"BUILD_ID",
  "name": "string",
  "packaging": "NONE"|"ZIP"
}

--environment (structure)

Information about the build environment for the build project.

Shorthand Syntax:

type=string,image=string,computeType=string,environmentVariables=[{name=string,value=string,type=string},{name=string,value=string,type=string}],privilegedMode=boolean

JSON Syntax:

{
  "type": "LINUX_CONTAINER",
  "image": "string",
  "computeType": "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE",
  "environmentVariables": [
    {
      "name": "string",
      "value": "string",
      "type": "PLAINTEXT"|"PARAMETER_STORE"
    }
    ...
  ],
  "privilegedMode": true|false
}

--service-role (string)

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

--timeout-in-minutes (integer)

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.

--encryption-key (string)

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format ``alias/alias-name `` ).

--tags (list)

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

project -> (structure)

Information about the build project that was created.

name -> (string)

The name of the build project.

arn -> (string)

The Amazon Resource Name (ARN) of the build project.

description -> (string)

A description that makes the build project easy to identify.

source -> (structure)

Information about the build input source code for this build project.

type -> (string)

The type of repository that contains the source code to be built. Valid values include:

  • BITBUCKET : The source code is in a Bitbucket repository.
  • CODECOMMIT : The source code is in an AWS CodeCommit repository.
  • CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
  • GITHUB : The source code is in a GitHub repository.
  • S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

location -> (string)

Information about the location of the source code to be built. Valid values include:

  • For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
  • For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, ``https://git-codecommit.*region-ID* .amazonaws.com/v1/repos/repo-name `` ).
  • For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, `` bucket-name /path /to /object-name .zip`` )
  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page that displays, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to. Then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH .
  • For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page that displays, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH .

buildspec -> (string)

The build spec declaration to use for the builds in this build project.

If this value is not specified, a build spec must be included along with the source code to be built.

auth -> (structure)

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB ).

type -> (string)

The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.

resource -> (string)

The resource value that applies to the specified authorization type.

artifacts -> (structure)

Information about the build output artifacts for the build project.

type -> (string)

The type of build output artifact. Valid values include:

  • CODEPIPELINE : The build project will have build output generated through AWS CodePipeline.
  • NO_ARTIFACTS : The build project will not produce any build output.
  • S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).

location -> (string)

Information about the build output artifact location, as follows:

  • If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
  • If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3 , this is the name of the output bucket.

path -> (string)

Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
  • If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .

namespaceType -> (string)

Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

  • If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
  • If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3 , then valid values include:
    • BUILD_ID : Include the build ID in the location of the build output artifact.
    • NONE : Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/*build-ID* /MyArtifact.zip .

name -> (string)

Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
  • If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3 , this is the name of the output artifact object.

For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/*build-ID* /MyArtifact.zip .

packaging -> (string)

The type of build output artifact to create, as follows:

  • If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
  • If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3 , valid values include:
    • NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
    • ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

environment -> (structure)

Information about the build environment for this build project.

type -> (string)

The type of build environment to use for related builds.

image -> (string)

The ID of the Docker image to use for this build project.

computeType -> (string)

Information about the compute resources the build project will use. Available values include:

  • BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
  • BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
  • BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.

environmentVariables -> (list)

A set of environment variables to make available to builds for this build project.

(structure)

Information about an environment variable for a build project or a build.

name -> (string)

The name or key of the environment variable.

value -> (string)

The value of the environment variable.

Warning

We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

type -> (string)

The type of environment variable. Valid values include:

  • PARAMETER_STORE : An environment variable stored in Amazon EC2 Systems Manager Parameter Store.
  • PLAINTEXT : An environment variable in plaintext format.

privilegedMode -> (boolean)

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

serviceRole -> (string)

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

timeoutInMinutes -> (integer)

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

encryptionKey -> (string)

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format ``alias/alias-name `` ).

tags -> (list)

The tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

(structure)

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

key -> (string)

The tag's key.

value -> (string)

The tag's value.

created -> (timestamp)

When the build project was created, expressed in Unix time format.

lastModified -> (timestamp)

When the build project's settings were last modified, expressed in Unix time format.

webhook -> (structure)

Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.

url -> (string)

The URL to the webhook.