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.
Update-CBProject-Name <String>-Artifacts_ArtifactIdentifier <String>-BadgeEnabled <Boolean>-BuildBatchConfig_BatchReportMode <BatchReportModeType>-Artifacts_BucketOwnerAccess <BucketOwnerAccess>-S3Logs_BucketOwnerAccess <BucketOwnerAccess>-Source_Buildspec <String>-Environment_Certificate <String>-BuildBatchConfig_CombineArtifact <Boolean>-Environment_ComputeType <ComputeType>-Restrictions_ComputeTypesAllowed <String[]>-ConcurrentBuildLimit <Int32>-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>
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
type
is set to CODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.type
is set to NO_ARTIFACTS
, this value is ignored if specified, because no build output is produced.type
is set to S3
, this is the name of the output bucket.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
path
and namespaceType
, the pattern that CodeBuild uses to name and store the output artifact:type
is set to CODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.type
is set to NO_ARTIFACTS
, this value is ignored if specified, because no build output is produced.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.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
.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. 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) |
path
and name
, the pattern that CodeBuild uses to determine the name and location to store the output artifact:type
is set to CODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.type
is set to NO_ARTIFACTS
, this value is ignored if specified, because no build output is produced.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.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) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
type
is set to CODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.type
is set to NO_ARTIFACTS
, this value is ignored if specified, because no build output is produced.type
is set to S3
, valid values include:NONE
: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging
is not specified.ZIP
: CodeBuild creates in the output bucket a ZIP file that contains the build output.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
namespaceType
and name
, the pattern that CodeBuild uses to name and store the output artifact:type
is set to CODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.type
is set to NO_ARTIFACTS
, this value is ignored if specified, because no build output is produced.type
is set to S3
, this is the path to the output artifact. If path
is not specified, path
is not used.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) |
CODEPIPELINE
: The build project has build output generated through 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 S3.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Source_Auth_Resource |
OAUTH
, which represents the OAuth authorization type. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Source_Auth_Type |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | BuildBatchConfig_CombineArtifacts |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | BuildBatchConfig_TimeoutInMins |
name
parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.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) |
Aliases | Source_BuildStatusConfig_Context |
url
parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.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) |
Aliases | Source_BuildStatusConfig_TargetUrl |
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) |
LOCAL
cache types.Possible values are:privileged
flag must be set so that your project has the required Docker permissions. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Cache_Modes |
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) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LogsConfig_CloudWatchLogs_GroupName |
ENABLED
: CloudWatch Logs are enabled for this build project.DISABLED
: CloudWatch Logs are not enabled for this build project.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LogsConfig_CloudWatchLogs_Status |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LogsConfig_CloudWatchLogs_StreamName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
alias/<alias-name>
). Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.BUILD_GENERAL1_LARGE
: LINUX_CONTAINER
, you can use up to 15 GB memory and 8 vCPUs for builds. LINUX_GPU_CONTAINER
, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.ARM_CONTAINER
, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Environment_EnvironmentVariables |
<registry>/<repository>:<tag>
. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0
. <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) |
CODEBUILD
specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. SERVICE_ROLE
specifies that CodeBuild uses your build project's service role. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
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).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).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).WINDOWS_CONTAINER
and WINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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) |
Aliases | FileSystemLocations |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Source_GitSubmodulesConfig_FetchSubmodules |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | QueuedTimeoutInMinutes |
credential
can use the name of the credentials only if they exist in your current Amazon Web Services Region. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Environment_RegistryCredential_Credential |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Environment_RegistryCredential_CredentialProvider |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | BuildBatchConfig_Restrictions_ComputeTypesAllowed |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | BuildBatchConfig_Restrictions_MaximumBuildsAllowed |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LogsConfig_S3Logs_BucketOwnerAccess |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LogsConfig_S3Logs_EncryptionDisabled |
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) |
Aliases | LogsConfig_S3Logs_Location |
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) |
Aliases | LogsConfig_S3Logs_Status |
ProjectArtifact
objects. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SecondaryArtifacts |
ProjectSource
objects. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SecondarySources |
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) |
Aliases | SecondarySourceVersions |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
CODEBUILD_SRC_DIR
environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services 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) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
location
should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>
).<bucket-name>/<path>/<object-name>.zip
).<bucket-name>/<path-to-source-code>/<folder>/
).source
object, set the auth
object's type
value to OAUTH
.source
object, set the auth
object's type
value to OAUTH
.CODEPIPELINE
for the Type
property, don't specify this property. For all of the other types, you must specify Location
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
invalidInputException
is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.The status of a build triggered by a webhook is always reported to your source provider.If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
BITBUCKET
: The source code is in a Bitbucket repository.CODECOMMIT
: The source code is in an CodeCommit repository.CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in 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 S3 bucket.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.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 CodeBuild User Guide. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TimeoutInMinutes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_SecurityGroupIds |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_Subnets |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z