UpdateProject - AWS CodeBuild
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

UpdateProject

Changes the settings of a build project.

Request Syntax

{
   "artifacts": { 
      "artifactIdentifier": "string",
      "bucketOwnerAccess": "string",
      "encryptionDisabled": boolean,
      "location": "string",
      "name": "string",
      "namespaceType": "string",
      "overrideArtifactName": boolean,
      "packaging": "string",
      "path": "string",
      "type": "string"
   },
   "autoRetryLimit": number,
   "badgeEnabled": boolean,
   "buildBatchConfig": { 
      "batchReportMode": "string",
      "combineArtifacts": boolean,
      "restrictions": { 
         "computeTypesAllowed": [ "string" ],
         "maximumBuildsAllowed": number
      },
      "serviceRole": "string",
      "timeoutInMins": number
   },
   "cache": { 
      "location": "string",
      "modes": [ "string" ],
      "type": "string"
   },
   "concurrentBuildLimit": number,
   "description": "string",
   "encryptionKey": "string",
   "environment": { 
      "certificate": "string",
      "computeConfiguration": { 
         "disk": number,
         "machineType": "string",
         "memory": number,
         "vCpu": number
      },
      "computeType": "string",
      "environmentVariables": [ 
         { 
            "name": "string",
            "type": "string",
            "value": "string"
         }
      ],
      "fleet": { 
         "fleetArn": "string"
      },
      "image": "string",
      "imagePullCredentialsType": "string",
      "privilegedMode": boolean,
      "registryCredential": { 
         "credential": "string",
         "credentialProvider": "string"
      },
      "type": "string"
   },
   "fileSystemLocations": [ 
      { 
         "identifier": "string",
         "location": "string",
         "mountOptions": "string",
         "mountPoint": "string",
         "type": "string"
      }
   ],
   "logsConfig": { 
      "cloudWatchLogs": { 
         "groupName": "string",
         "status": "string",
         "streamName": "string"
      },
      "s3Logs": { 
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "status": "string"
      }
   },
   "name": "string",
   "queuedTimeoutInMinutes": number,
   "secondaryArtifacts": [ 
      { 
         "artifactIdentifier": "string",
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "name": "string",
         "namespaceType": "string",
         "overrideArtifactName": boolean,
         "packaging": "string",
         "path": "string",
         "type": "string"
      }
   ],
   "secondarySources": [ 
      { 
         "auth": { 
            "resource": "string",
            "type": "string"
         },
         "buildspec": "string",
         "buildStatusConfig": { 
            "context": "string",
            "targetUrl": "string"
         },
         "gitCloneDepth": number,
         "gitSubmodulesConfig": { 
            "fetchSubmodules": boolean
         },
         "insecureSsl": boolean,
         "location": "string",
         "reportBuildStatus": boolean,
         "sourceIdentifier": "string",
         "type": "string"
      }
   ],
   "secondarySourceVersions": [ 
      { 
         "sourceIdentifier": "string",
         "sourceVersion": "string"
      }
   ],
   "serviceRole": "string",
   "source": { 
      "auth": { 
         "resource": "string",
         "type": "string"
      },
      "buildspec": "string",
      "buildStatusConfig": { 
         "context": "string",
         "targetUrl": "string"
      },
      "gitCloneDepth": number,
      "gitSubmodulesConfig": { 
         "fetchSubmodules": boolean
      },
      "insecureSsl": boolean,
      "location": "string",
      "reportBuildStatus": boolean,
      "sourceIdentifier": "string",
      "type": "string"
   },
   "sourceVersion": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "timeoutInMinutes": number,
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnets": [ "string" ],
      "vpcId": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

name

The name of the build project.

Note

You cannot change a build project's name.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

artifacts

Information to be changed about the build output artifacts for the build project.

Type: ProjectArtifacts object

Required: No

autoRetryLimit

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

Type: Integer

Required: No

badgeEnabled

Set this to true to generate a publicly accessible URL for your project's build badge.

Type: Boolean

Required: No

buildBatchConfig

Contains configuration information about a batch build project.

Type: ProjectBuildBatchConfig object

Required: No

cache

Stores recently used information so that it can be quickly accessed at a later time.

Type: ProjectCache object

Required: No

concurrentBuildLimit

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

Type: Integer

Required: No

description

A new or replacement description of the build project.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

encryptionKey

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

Note

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

environment

Information to be changed about the build environment for the build project.

Type: ProjectEnvironment object

Required: No

fileSystemLocations

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

Type: Array of ProjectFileSystemLocation objects

Required: No

logsConfig

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

Type: LogsConfig object

Required: No

queuedTimeoutInMinutes

The number of minutes a build is allowed to be queued before it times out.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 480.

Required: No

secondaryArtifacts

An array of ProjectArtifact objects.

Type: Array of ProjectArtifacts objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySources

An array of ProjectSource objects.

Type: Array of ProjectSource objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySourceVersions

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Type: Array of ProjectSourceVersion objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

serviceRole

The replacement ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Type: String

Length Constraints: Minimum length of 1.

Required: No

source

Information to be changed about the build input source code for the build project.

Type: ProjectSource object

Required: No

sourceVersion

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For GitLab: the commit ID, branch, or Git tag to use.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Type: String

Required: No

tags

An updated list of tag key and value pairs associated with this build project.

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

timeoutInMinutes

The replacement value in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 2160.

Required: No

vpcConfig

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

Type: VpcConfig object

Required: No

Response Syntax

{
   "project": { 
      "arn": "string",
      "artifacts": { 
         "artifactIdentifier": "string",
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "name": "string",
         "namespaceType": "string",
         "overrideArtifactName": boolean,
         "packaging": "string",
         "path": "string",
         "type": "string"
      },
      "autoRetryLimit": number,
      "badge": { 
         "badgeEnabled": boolean,
         "badgeRequestUrl": "string"
      },
      "buildBatchConfig": { 
         "batchReportMode": "string",
         "combineArtifacts": boolean,
         "restrictions": { 
            "computeTypesAllowed": [ "string" ],
            "maximumBuildsAllowed": number
         },
         "serviceRole": "string",
         "timeoutInMins": number
      },
      "cache": { 
         "location": "string",
         "modes": [ "string" ],
         "type": "string"
      },
      "concurrentBuildLimit": number,
      "created": number,
      "description": "string",
      "encryptionKey": "string",
      "environment": { 
         "certificate": "string",
         "computeConfiguration": { 
            "disk": number,
            "machineType": "string",
            "memory": number,
            "vCpu": number
         },
         "computeType": "string",
         "environmentVariables": [ 
            { 
               "name": "string",
               "type": "string",
               "value": "string"
            }
         ],
         "fleet": { 
            "fleetArn": "string"
         },
         "image": "string",
         "imagePullCredentialsType": "string",
         "privilegedMode": boolean,
         "registryCredential": { 
            "credential": "string",
            "credentialProvider": "string"
         },
         "type": "string"
      },
      "fileSystemLocations": [ 
         { 
            "identifier": "string",
            "location": "string",
            "mountOptions": "string",
            "mountPoint": "string",
            "type": "string"
         }
      ],
      "lastModified": number,
      "logsConfig": { 
         "cloudWatchLogs": { 
            "groupName": "string",
            "status": "string",
            "streamName": "string"
         },
         "s3Logs": { 
            "bucketOwnerAccess": "string",
            "encryptionDisabled": boolean,
            "location": "string",
            "status": "string"
         }
      },
      "name": "string",
      "projectVisibility": "string",
      "publicProjectAlias": "string",
      "queuedTimeoutInMinutes": number,
      "resourceAccessRole": "string",
      "secondaryArtifacts": [ 
         { 
            "artifactIdentifier": "string",
            "bucketOwnerAccess": "string",
            "encryptionDisabled": boolean,
            "location": "string",
            "name": "string",
            "namespaceType": "string",
            "overrideArtifactName": boolean,
            "packaging": "string",
            "path": "string",
            "type": "string"
         }
      ],
      "secondarySources": [ 
         { 
            "auth": { 
               "resource": "string",
               "type": "string"
            },
            "buildspec": "string",
            "buildStatusConfig": { 
               "context": "string",
               "targetUrl": "string"
            },
            "gitCloneDepth": number,
            "gitSubmodulesConfig": { 
               "fetchSubmodules": boolean
            },
            "insecureSsl": boolean,
            "location": "string",
            "reportBuildStatus": boolean,
            "sourceIdentifier": "string",
            "type": "string"
         }
      ],
      "secondarySourceVersions": [ 
         { 
            "sourceIdentifier": "string",
            "sourceVersion": "string"
         }
      ],
      "serviceRole": "string",
      "source": { 
         "auth": { 
            "resource": "string",
            "type": "string"
         },
         "buildspec": "string",
         "buildStatusConfig": { 
            "context": "string",
            "targetUrl": "string"
         },
         "gitCloneDepth": number,
         "gitSubmodulesConfig": { 
            "fetchSubmodules": boolean
         },
         "insecureSsl": boolean,
         "location": "string",
         "reportBuildStatus": boolean,
         "sourceIdentifier": "string",
         "type": "string"
      },
      "sourceVersion": "string",
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "timeoutInMinutes": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnets": [ "string" ],
         "vpcId": "string"
      },
      "webhook": { 
         "branchFilter": "string",
         "buildType": "string",
         "filterGroups": [ 
            [ 
               { 
                  "excludeMatchedPattern": boolean,
                  "pattern": "string",
                  "type": "string"
               }
            ]
         ],
         "lastModifiedSecret": number,
         "manualCreation": boolean,
         "payloadUrl": "string",
         "scopeConfiguration": { 
            "domain": "string",
            "name": "string",
            "scope": "string"
         },
         "secret": "string",
         "url": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

project

Information about the build project that was changed.

Type: Project object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: