aws codebuild update-project
Changes the settings of a build project
Options
| Name | Description |
|---|---|
--name <string> | The name of the build project. You cannot change a build project's name |
--description <string> | A new or replacement description of the build project |
--source <structure> | Information to be changed about the build input source code for the build project |
--secondary-sources <list> | An array of ProjectSource objects |
--source-version <string> | 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 AWS 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 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 |
--secondary-source-versions <list> | An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level) |
--artifacts <structure> | Information to be changed about the build output artifacts for the build project |
--secondary-artifacts <list> | An array of ProjectSource objects |
--cache <structure> | Stores recently used information so that it can be quickly accessed at a later time |
--environment <structure> | Information to be changed about the build environment for the build project |
--service-role <string> | The replacement 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> | The replacement value 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 |
--queued-timeout-in-minutes <integer> | The number of minutes a build is allowed to be queued before it times out |
--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 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>) |
--tags <list> | 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 |
--vpc-config <structure> | VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC |
--badge-enabled | Set this to true to generate a publicly accessible URL for your project's build badge |
--no-badge-enabled | Set this to true to generate a publicly accessible URL for your project's build badge |
--logs-config <structure> | Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both |
--file-system-locations <list> | 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 |
--build-batch-config <structure> | Contains configuration information about a batch build project |
--concurrent-build-limit <integer> | 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 |
--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--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 |