Synopsis
Calls the AWS CodeBuild UpdateProject API operation.
Syntax
Update-CBProject-Name <String>-BadgeEnabled <Boolean>-Source_Buildspec <String>-Environment_Certificate <String>-Environment_ComputeType <ComputeType>-Description <String>-EncryptionKey <String>-Environment_EnvironmentVariable <EnvironmentVariable[]>-Source_GitCloneDepth <Int32>-Environment_Image <String>-Source_InsecureSsl <Boolean>-Artifacts_Location <String>-Cache_Location <String>-Source_Location <String>-Artifacts_Name <String>-Artifacts_NamespaceType <ArtifactNamespace>-Artifacts_Packaging <ArtifactPackaging>-Artifacts_Path <String>-Environment_PrivilegedMode <Boolean>-Auth_Resource <String>-VpcConfig_SecurityGroupId <String[]>-ServiceRole <String>-VpcConfig_Subnet <String[]>-Tag <Tag[]>-TimeoutInMinute <Int32>-Artifacts_Type <ArtifactsType>-Cache_Type <CacheType>-Environment_Type <EnvironmentType>-Auth_Type <SourceAuthType>-Source_Type <SourceType>-VpcConfig_VpcId <String>-Force <SwitchParameter>
Description
Changes the settings of a build project.
Parameters
-Artifacts_Location <String>
Information about the build output artifact location, as follows:
- If
typeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If
typeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. - If
typeis set toS3, this is the name of the output bucket.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Artifacts_Name <String>
Along with
path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:- If
typeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If
typeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), then the artifact is stored in the root of the output bucket.
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact would be stored inMyArtifacts/build-ID/MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", then the output artifact would be stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", then the output artifact would be stored inMyArtifacts/build-ID.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Artifacts_NamespaceType <ArtifactNamespace>
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
typeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If
typeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. - If
typeis set toS3, 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 ifnamespaceTypeis not specified.
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Artifacts_Packaging <ArtifactPackaging>
The type of build output artifact to create, as follows:
- If
typeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If
typeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. - If
typeis set toS3, valid values include:NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Artifacts_Path <String>
Along with
namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:- If
typeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If
typeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified, thenpathwill not be used.
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Artifacts_Type <ArtifactsType>
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).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Auth_Resource <String>
The resource value that applies to the specified authorization type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Auth_Type <SourceAuthType>
The authorization type to use. The only valid value is
OAUTH, which represents the OAuth authorization type. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-Cache_Location <String>
Information about the cache location, as follows:
NO_CACHE: This value will be ignored.S3: This is the S3 bucket name/prefix.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Cache_Type <CacheType>
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project will not use any cache.S3: The build project will read and write from/to S3.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Description <String>
A new or replacement description of the build project.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EncryptionKey <String>
The replacement 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). | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_Certificate <String>
The certificate to use with this build project.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_ComputeType <ComputeType>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_EnvironmentVariable <EnvironmentVariable[]>
A set of environment variables to make available to builds for this build project.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_Image <String>
The ID of the Docker image to use for this build project.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_PrivilegedMode <Boolean>
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not 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 builds can interact with it. One way to do this is to initialize the Docker daemon during 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" | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Environment_Type <EnvironmentType>
The type of build environment to use for related builds.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-Name <String>
The name of the build project.You cannot change a build project's name.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-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? | False |
-Source_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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Source_GitCloneDepth <Int32>
Information about the git clone depth for the build project.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Source_InsecureSsl <Boolean>
Enable this flag to ignore SSL warnings while connecting to the project source code.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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,
locationshould 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
sourceobject, set theauthobject'stypevalue toOAUTH. - 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
sourceobject, set theauthobject'stypevalue toOAUTH.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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 repository.S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <Tag[]>
The replacement set of tags for 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? | False |
-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? | False |
-VpcConfig_SecurityGroupId <String[]>
A list of one or more security groups IDs in your Amazon VPC.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VpcConfig_Subnet <String[]>
A list of one or more subnet IDs in your Amazon VPC.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-VpcConfig_VpcId <String>
The ID of the Amazon VPC.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the Name parameter.
Outputs
This cmdlet returns a 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.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
