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

Invokes the StartBuild operation against AWS CodeBuild.

Syntax

Start-CBBuild
-ProjectName <String>
-BuildspecOverride <String>
-EnvironmentVariablesOverride <EnvironmentVariable[]>
-ArtifactsOverride_Location <String>
-ArtifactsOverride_Name <String>
-ArtifactsOverride_NamespaceType <ArtifactNamespace>
-ArtifactsOverride_Packaging <ArtifactPackaging>
-ArtifactsOverride_Path <String>
-SourceVersion <String>
-TimeoutInMinutesOverride <Int32>
-ArtifactsOverride_Type <ArtifactsType>
-Force <SwitchParameter>

Description

Starts running a build.

Parameters

-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.
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_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_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
-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
-ProjectName <String>
The name of the build project to start running a build.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-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 or GitHub: the commit ID to use.
  • 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