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>
-RegistryCredentialOverride_Credential <String>
-RegistryCredentialOverride_CredentialProvider <CredentialProviderType>
-ArtifactsOverride_EncryptionDisabled <Boolean>
-S3Logs_EncryptionDisabled <Boolean>
-EnvironmentTypeOverride <EnvironmentType>
-EnvironmentVariablesOverride <EnvironmentVariable[]>
-GitSubmodulesConfigOverride_FetchSubmodule <Boolean>
-GitCloneDepthOverride <Int32>
-CloudWatchLogs_GroupName <String>
-IdempotencyToken <String>
-ImageOverride <String>
-ImagePullCredentialsTypeOverride <ImagePullCredentialsType>
-InsecureSslOverride <Boolean>
-ArtifactsOverride_Location <String>
-CacheOverride_Location <String>
-S3Logs_Location <String>
-CacheOverride_Mode <String[]>
-ArtifactsOverride_Name <String>
-ArtifactsOverride_NamespaceType <ArtifactNamespace>
-ArtifactsOverride_OverrideArtifactName <Boolean>
-ArtifactsOverride_Packaging <ArtifactPackaging>
-ArtifactsOverride_Path <String>
-PrivilegedModeOverride <Boolean>
-QueuedTimeoutInMinutesOverride <Int32>
-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 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?False
-ArtifactsOverride_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?False
-ArtifactsOverride_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?False
-ArtifactsOverride_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?False
-ArtifactsOverride_OverrideArtifactName <Boolean>
If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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:
  • 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?False
-ArtifactsOverride_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?False
-ArtifactsOverride_Type <ArtifactsType>
The type of build output artifact. Valid values include:
  • CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
  • 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?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:
  • NO_CACHE or LOCAL: This value is ignored.
  • S3: This is the S3 bucket name/prefix.
Required?False
Position?Named
Accept pipeline input?False
-CacheOverride_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 overriden 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?False
AliasesCacheOverride_Modes
-CacheOverride_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?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 logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
Required?False
Position?Named
Accept pipeline input?False
AliasesLogsConfigOverride_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?False
AliasesLogsConfigOverride_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?False
AliasesLogsConfigOverride_CloudWatchLogs_StreamName
-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
-GitSubmodulesConfigOverride_FetchSubmodule <Boolean>
Set to true to fetch Git submodules for your AWS CodeBuild build project.
Required?False
Position?Named
Accept pipeline input?False
AliasesGitSubmodulesConfigOverride_FetchSubmodules
-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
-ImagePullCredentialsTypeOverride <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 using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
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, )
-QueuedTimeoutInMinutesOverride <Int32>
The number of minutes a build is allowed to be queued before it times out.
Required?False
Position?Named
Accept pipeline input?False
-RegistryCredentialOverride_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 region.
Required?False
Position?Named
Accept pipeline input?False
-RegistryCredentialOverride_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?False
-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, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
Required?False
Position?Named
Accept pipeline input?False
-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?False
AliasesLogsConfigOverride_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?False
AliasesLogsConfigOverride_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?False
AliasesLogsConfigOverride_S3Logs_Status
-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>
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?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 is 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 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 project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
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 Amazon.CodeBuild.Model.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