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 StartBuild API operation.

Syntax

Start-CBBuild
-ProjectName <String>
-ArtifactsOverride_ArtifactIdentifier <String>
-BuildspecOverride <String>
-CertificateOverride <String>
-ComputeTypeOverride <ComputeType>
-ArtifactsOverride_EncryptionDisabled <Boolean>
-EnvironmentTypeOverride <EnvironmentType>
-EnvironmentVariablesOverride <EnvironmentVariable[]>
-GitCloneDepthOverride <Int32>
-CloudWatchLogs_GroupName <String>
-IdempotencyToken <String>
-ImageOverride <String>
-InsecureSslOverride <Boolean>
-ArtifactsOverride_Location <String>
-CacheOverride_Location <String>
-S3Logs_Location <String>
-ArtifactsOverride_Name <String>
-ArtifactsOverride_NamespaceType <ArtifactNamespace>
-ArtifactsOverride_OverrideArtifactName <Boolean>
-ArtifactsOverride_Packaging <ArtifactPackaging>
-ArtifactsOverride_Path <String>
-PrivilegedModeOverride <Boolean>
-ReportBuildStatusOverride <Boolean>
-SourceAuthOverride_Resource <String>
-SecondaryArtifactsOverride <ProjectArtifacts[]>
-SecondarySourcesOverride <ProjectSource[]>
-SecondarySourcesVersionOverride <ProjectSourceVersion[]>
-ServiceRoleOverride <String>
-SourceLocationOverride <String>
-SourceTypeOverride <SourceType>
-SourceVersion <String>
-CloudWatchLogs_Status <LogsConfigStatusType>
-S3Logs_Status <LogsConfigStatusType>
-CloudWatchLogs_StreamName <String>
-TimeoutInMinutesOverride <Int32>
-ArtifactsOverride_Type <ArtifactsType>
-CacheOverride_Type <CacheType>
-SourceAuthOverride_Type <SourceAuthType>
-Force <SwitchParameter>

Description

Starts running a build.

Parameters

-ArtifactsOverride_ArtifactIdentifier <String>
An identifier for this artifact definition.
Required?False
Position?Named
Accept pipeline input?False
-ArtifactsOverride_EncryptionDisabled <Boolean>
Set to true if you do not want your output artifacts encrypted. This option is only valid if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException will be thrown.
Required?False
Position?Named
Accept pipeline input?False
-ArtifactsOverride_Location <String>
Information about the build output artifact location, as follows:
  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3, this is the name of the output bucket.
Required?False
Position?Named
Accept pipeline input?False
-ArtifactsOverride_Name <String>
Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be 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 ("/"), then 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 would be stored in MyArtifacts/build-ID/MyArtifact.zip.
  • If path is empty, namespaceType is set to NONE, and name is set to "/", then the output artifact would be 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 "/", then the output artifact would be stored in MyArtifacts/build-ID.
Required?False
Position?Named
Accept pipeline input?False
-ArtifactsOverride_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 type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3, 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 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, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.
Required?False
Position?Named
Accept pipeline input?False
-ArtifactsOverride_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?False
-ArtifactsOverride_Packaging <ArtifactPackaging>
The type of build output artifact to create, as follows:
  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3, valid values include:
    • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is 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
-ArtifactsOverride_Path <String>
Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
  • If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.
For example, if 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
-ArtifactsOverride_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
-BuildspecOverride <String>
A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
Required?False
Position?Named
Accept pipeline input?False
-CacheOverride_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
-CacheOverride_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
-CertificateOverride <String>
The name of a certificate for this build that overrides the one specified in the build project.
Required?False
Position?Named
Accept pipeline input?False
-CloudWatchLogs_GroupName <String>
The group name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams
Required?False
Position?Named
Accept pipeline input?False
-CloudWatchLogs_Status <LogsConfigStatusType>
The current status of the 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?False
-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?False
-ComputeTypeOverride <ComputeType>
The name of a compute type for this build that overrides the one specified in the build project.
Required?False
Position?Named
Accept pipeline input?False
-EnvironmentTypeOverride <EnvironmentType>
A container type for this build that overrides the one specified in the build project.
Required?False
Position?Named
Accept pipeline input?False
-EnvironmentVariablesOverride <EnvironmentVariable[]>
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
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
-GitCloneDepthOverride <Int32>
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
Required?False
Position?Named
Accept pipeline input?False
-IdempotencyToken <String>
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
Required?False
Position?Named
Accept pipeline input?False
-ImageOverride <String>
The name of an image for this build that overrides the one specified in the build project.
Required?False
Position?Named
Accept pipeline input?False
-InsecureSslOverride <Boolean>
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
Required?False
Position?Named
Accept pipeline input?False
-PrivilegedModeOverride <Boolean>
Enable this flag to override privileged mode in the build project.
Required?False
Position?Named
Accept pipeline input?False
-ProjectName <String>
The name of the AWS CodeBuild build project to start running a build.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-ReportBuildStatusOverride <Boolean>
Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, an invalidInputException is thrown.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-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?False
-SecondaryArtifactsOverride <ProjectArtifacts[]>
An array of ProjectArtifacts objects.
Required?False
Position?Named
Accept pipeline input?False
-SecondarySourcesOverride <ProjectSource[]>
An array of ProjectSource objects.
Required?False
Position?Named
Accept pipeline input?False
-SecondarySourcesVersionOverride <ProjectSourceVersion[]>
An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
Required?False
Position?Named
Accept pipeline input?False
-ServiceRoleOverride <String>
The name of a service role for this build that overrides the one specified in the build project.
Required?False
Position?Named
Accept pipeline input?False
-SourceAuthOverride_Resource <String>
The resource value that applies to the specified authorization type.
Required?False
Position?Named
Accept pipeline input?False
-SourceAuthOverride_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
-SourceLocationOverride <String>
A location that overrides for this build the source location for the one defined in the build project.
Required?False
Position?Named
Accept pipeline input?False
-SourceTypeOverride <SourceType>
A source input type for this build that overrides the source input defined in the build project.
Required?False
Position?Named
Accept pipeline input?False
-SourceVersion <String>
A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:
  • For AWS CodeCommit: the commit ID 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 will be used. If not specified, the default branch's HEAD commit ID will be 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 will be used. If not specified, the default branch's HEAD commit ID will be used.
  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.
Required?False
Position?Named
Accept pipeline input?False
-TimeoutInMinutesOverride <Int32>
The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
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 ProjectName parameter.

Outputs

This cmdlet returns a Build object. The service call response (type Amazon.CodeBuild.Model.StartBuildResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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