AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS CodeBuild UpdateProject API operation.

Syntax

Update-CBProject
-Name <String>
-Artifacts_ArtifactIdentifier <String>
-BadgeEnabled <Boolean>
-Source_Buildspec <String>
-Environment_Certificate <String>
-BuildBatchConfig_CombineArtifact <Boolean>
-Environment_ComputeType <ComputeType>
-Restrictions_ComputeTypesAllowed <String[]>
-BuildStatusConfig_Context <String>
-RegistryCredential_Credential <String>
-RegistryCredential_CredentialProvider <CredentialProviderType>
-Description <String>
-Artifacts_EncryptionDisabled <Boolean>
-S3Logs_EncryptionDisabled <Boolean>
-EncryptionKey <String>
-Environment_EnvironmentVariable <EnvironmentVariable[]>
-GitSubmodulesConfig_FetchSubmodule <Boolean>
-FileSystemLocation <ProjectFileSystemLocation[]>
-Source_GitCloneDepth <Int32>
-CloudWatchLogs_GroupName <String>
-Environment_Image <String>
-Environment_ImagePullCredentialsType <ImagePullCredentialsType>
-Source_InsecureSsl <Boolean>
-Artifacts_Location <String>
-Cache_Location <String>
-S3Logs_Location <String>
-Source_Location <String>
-Restrictions_MaximumBuildsAllowed <Int32>
-Cache_Mode <String[]>
-Artifacts_Name <String>
-Artifacts_NamespaceType <ArtifactNamespace>
-Artifacts_OverrideArtifactName <Boolean>
-Artifacts_Packaging <ArtifactPackaging>
-Artifacts_Path <String>
-Environment_PrivilegedMode <Boolean>
-QueuedTimeoutInMinute <Int32>
-Source_ReportBuildStatus <Boolean>
-Auth_Resource <String>
-SecondaryArtifact <ProjectArtifacts[]>
-SecondarySource <ProjectSource[]>
-SecondarySourceVersion <ProjectSourceVersion[]>
-VpcConfig_SecurityGroupId <String[]>
-BuildBatchConfig_ServiceRole <String>
-ServiceRole <String>
-Source_SourceIdentifier <String>
-SourceVersion <String>
-CloudWatchLogs_Status <LogsConfigStatusType>
-S3Logs_Status <LogsConfigStatusType>
-CloudWatchLogs_StreamName <String>
-VpcConfig_Subnet <String[]>
-Tag <Tag[]>
-BuildStatusConfig_TargetUrl <String>
-BuildBatchConfig_TimeoutInMin <Int32>
-TimeoutInMinute <Int32>
-Artifacts_Type <ArtifactsType>
-Cache_Type <CacheType>
-Environment_Type <EnvironmentType>
-Auth_Type <SourceAuthType>
-Source_Type <SourceType>
-VpcConfig_VpcId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Changes the settings of a build project.

Parameters

-Artifacts_ArtifactIdentifier <String>
An identifier for this artifact definition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_EncryptionDisabled <Boolean>
Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_Location <String>
Information about the build output artifact location:
  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the name of the output bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_Name <String>
Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
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 is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
  • If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket.
  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_NamespaceType <ArtifactNamespace>
Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, 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, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_OverrideArtifactName <Boolean>
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_Packaging <ArtifactPackaging>
The type of build output artifact to create:
  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, valid values include:
    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_Path <String>
Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Artifacts_Type <ArtifactsType>
The type of build output artifact. Valid values include:
  • CODEPIPELINE: The build project has build output generated through AWS CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts.
  • NO_ARTIFACTS: The build project does not produce any build output.
  • S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Auth_Resource <String>
The resource value that applies to the specified authorization type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Auth_Resource
-Auth_Type <SourceAuthType>
This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_Auth_Type
-BadgeEnabled <Boolean>
Set this to true to generate a publicly accessible URL for your project's build badge.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildBatchConfig_CombineArtifact <Boolean>
Specifies if the build artifacts for the batch build should be combined into a single artifact location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBuildBatchConfig_CombineArtifacts
-BuildBatchConfig_ServiceRole <String>
Specifies the service role ARN for the batch build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildBatchConfig_TimeoutInMin <Int32>
Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBuildBatchConfig_TimeoutInMins
-BuildStatusConfig_Context <String>
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
Bitbucket
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
GitHub/GitHub Enterprise Server
This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_BuildStatusConfig_Context
-BuildStatusConfig_TargetUrl <String>
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
Bitbucket
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
GitHub/GitHub Enterprise Server
This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_BuildStatusConfig_TargetUrl
-Cache_Location <String>
Information about the cache location:
  • NO_CACHE or LOCAL: This value is ignored.
  • S3: This is the S3 bucket name/prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cache_Mode <String[]>
If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.
  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
    • You can use a Docker layer cache in the Linux environment only.
    • The privileged flag must be set so that your project has the required Docker permissions.
    • You should consider the security implications before you use a Docker layer cache.
  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
    • Only directories can be specified for caching. You cannot specify individual files.
    • Symlinks are used to reference cached directories.
    • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCache_Modes
-Cache_Type <CacheType>
The type of cache used by the build project. Valid values include:
  • NO_CACHE: The build project does not use any cache.
  • S3: The build project reads and writes from and to S3.
  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchLogs_GroupName <String>
The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_CloudWatchLogs_GroupName
-CloudWatchLogs_Status <LogsConfigStatusType>
The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:
  • ENABLED: Amazon CloudWatch Logs are enabled for this build project.
  • DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_CloudWatchLogs_Status
-CloudWatchLogs_StreamName <String>
The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_CloudWatchLogs_StreamName
-Description <String>
A new or replacement description of the build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKey <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>).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_Certificate <String>
The certificate to use with this build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_ComputeType <ComputeType>
Information about the compute resources the build project uses. 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 16 GB memory and 8 vCPUs for builds, depending on your environment type.
  • BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
  • For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
  • For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
  • For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_EnvironmentVariable <EnvironmentVariable[]>
A set of environment variables to make available to builds for this build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironment_EnvironmentVariables
-Environment_Image <String>
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
  • For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest.
  • For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_ImagePullCredentialsType <ImagePullCredentialsType>
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
  • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
  • SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_PrivilegedMode <Boolean>
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:If the operating system's base image is Ubuntu Linux:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:- 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"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment_Type <EnvironmentType>
The type of build environment to use for related builds.
  • The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
  • The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
  • The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileSystemLocation <ProjectFileSystemLocation[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFileSystemLocations
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GitSubmodulesConfig_FetchSubmodule <Boolean>
Set to true to fetch Git submodules for your AWS CodeBuild build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_GitSubmodulesConfig_FetchSubmodules
-Name <String>
The name of the build project.You cannot change a build project's name.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QueuedTimeoutInMinute <Int32>
The number of minutes a build is allowed to be queued before it times out.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesQueuedTimeoutInMinutes
-RegistryCredential_Credential <String>
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The credential can use the name of the credentials only if they exist in your current AWS Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironment_RegistryCredential_Credential
-RegistryCredential_CredentialProvider <CredentialProviderType>
The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnvironment_RegistryCredential_CredentialProvider
-Restrictions_ComputeTypesAllowed <String[]>
An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBuildBatchConfig_Restrictions_ComputeTypesAllowed
-Restrictions_MaximumBuildsAllowed <Int32>
Specifies the maximum number of builds allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBuildBatchConfig_Restrictions_MaximumBuildsAllowed
-S3Logs_EncryptionDisabled <Boolean>
Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_S3Logs_EncryptionDisabled
-S3Logs_Location <String>
The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_S3Logs_Location
-S3Logs_Status <LogsConfigStatusType>
The current status of the S3 build logs. Valid values are:
  • ENABLED: S3 build logs are enabled for this build project.
  • DISABLED: S3 build logs are not enabled for this build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogsConfig_S3Logs_Status
-SecondaryArtifact <ProjectArtifacts[]>
An array of ProjectSource objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecondaryArtifacts
-SecondarySource <ProjectSource[]>
An array of ProjectSource objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecondarySources
-SecondarySourceVersion <ProjectSourceVersion[]>
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecondarySourceVersions
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Project'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceRole <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_Buildspec <String>
The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_GitCloneDepth <Int32>
Information about the Git clone depth for the build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_InsecureSsl <Boolean>
Enable this flag to ignore SSL warnings while connecting to the project source code.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_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 ignores 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 buildspec file (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, one of the following.
    • The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
    • The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to 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 buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_ReportBuildStatus <Boolean>
Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_SourceIdentifier <String>
An identifier for this project source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_Type <SourceType>
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 or GitHub Enterprise Cloud repository.
  • GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
  • NO_SOURCE: The project does not have input source code.
  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceVersion <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 Simple Storage Service (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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TimeoutInMinute <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTimeoutInMinutes
-VpcConfig_SecurityGroupId <String[]>
A list of one or more security groups IDs in your Amazon VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_Subnet <String[]>
A list of one or more subnet IDs in your Amazon VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_Subnets
-VpcConfig_VpcId <String>
The ID of the Amazon VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CodeBuild.Model.Project or Amazon.CodeBuild.Model.UpdateProjectResponse
This cmdlet returns an Amazon.CodeBuild.Model.Project object. The service call response (type Amazon.CodeBuild.Model.UpdateProjectResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z