Create a pipeline that uses CodeBuild (Amazon CLI)

Create or identify a build project in CodeBuild. For more information, see Create a build project.

Make sure you have configured the Amazon CLI with the Amazon access key and Amazon secret access key that correspond to one of the IAM entities described in this topic. For more information, see Getting set up with the Amazon Command Line Interface in the Amazon Command Line Interface User Guide.

Create a JSON-formatted file that represents the structure of the pipeline. Name the file create-pipeline.json or similar. For example, this JSON-formatted structure creates a pipeline with a source action that references an S3 input bucket and a build action that uses CodeBuild:

{
  "pipeline": {
    "roleArn": "arn:aws:iam::<account-id>:role/<AWS-CodePipeline-service-role-name>",
    "stages": [
      {
        "name": "Source",
        "actions": [
          {
            "inputArtifacts": [],
            "name": "Source",
            "actionTypeId": {
              "category": "Source",
              "owner": "AWS",
              "version": "1",
              "provider": "S3"
            },
            "outputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "configuration": {
              "S3Bucket": "<bucket-name>",
              "S3ObjectKey": "<source-code-file-name.zip>"
            },
            "runOrder": 1
          }
        ]
      },
      {
        "name": "Build",
        "actions": [
          {
            "inputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "name": "Build",
            "actionTypeId": {
              "category": "Build",
              "owner": "AWS",
              "version": "1",
              "provider": "CodeBuild"
            },
            "outputArtifacts": [
              {
                "name": "default"
              }
            ],
            "configuration": {
              "ProjectName": "<build-project-name>"
            },
            "runOrder": 1
          }
        ]
      }
    ],
    "artifactStore": {
      "type": "S3",
      "location": "<CodePipeline-internal-bucket-name>"
    },
    "name": "<my-pipeline-name>",
    "version": 1
  }
}

In this JSON-formatted data:

Although this data describes only a source action and a build action, you can add actions for activities related to testing, deploying the build output artifact, invoking Amazon Lambda functions, and more. For more information, see the Amazon CodePipeline pipeline structure reference in the Amazon CodePipeline User Guide.

Switch to the folder that contains the JSON file, and then run the CodePipeline create-pipeline command, specifying the file name:

aws codepipeline create-pipeline --cli-input-json file://create-pipeline.json

The JSON-formatted data appears in the output, and CodePipeline creates the pipeline.

To get information about the pipeline's status, run the CodePipeline get-pipeline-state command, specifying the name of the pipeline:

aws codepipeline get-pipeline-state --name <my-pipeline-name>

In the output, look for information that confirms the build was successful. Ellipses (...) are used to show data that has been omitted for brevity.

{
  ...
  "stageStates": [
    ...  
    {
      "actionStates": [
        {
          "actionName": "CodeBuild",
          "latestExecution": {
            "status": "SUCCEEDED",
            ...
          },
          ...
        }
      ]
    }
  ]
}

If you run this command too early, you might not see any information about the build action. You might need to run this command multiple times until the pipeline has finished running the build action.

After a successful build, follow these instructions to get the build output artifact. Open the Amazon S3 console at https://console.amazonaws.cn/s3/.

In the list of buckets, open the bucket used by the pipeline. The name of the bucket should follow the format codepipeline-<region-ID>-<random-number>. You can get the bucket name from the create-pipeline.json file or you can run the CodePipeline get-pipeline command to get the bucket's name.

aws codepipeline get-pipeline --name <pipeline-name>

In the output, the pipeline object contains an artifactStore object, which contains a location value with the name of the bucket.

Open the folder that matches the name of your pipeline (for example, <pipeline-name>).

In that folder, open the folder named default.

Extract the contents of the file. If there are multiple files in that folder, extract the contents of the file with the latest Last Modified timestamp. (You might need to give the file a .zip extension so that you can work with it in your system's ZIP utility.) The build output artifact is in the extracted contents of the file.