Module Smaws_Client_CodeBuild.Types

Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.

For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.

For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.

The type of webhook filter. There are 11 webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, REPOSITORY_NAME, ORGANIZATION_NAME, and WORKFLOW_NAME.

• EVENT

  • A webhook event triggers a build when the provided pattern matches one of nine event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.

    Types PULL_REQUEST_REOPENED and WORKFLOW_JOB_QUEUED work with GitHub and GitHub Enterprise only. Types RELEASED and PRERELEASED work with GitHub only.

• ACTOR_ACCOUNT_ID

  • A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

• HEAD_REF

  • A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

    Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

• BASE_REF

  • A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

    Works with pull request events only.

• FILE_PATH

  • A webhook triggers a build when the path of a changed file matches the regular expression pattern.

    Works with push and pull request events only.

• COMMIT_MESSAGE

  • A webhook triggers a build when the head commit message matches the regular expression pattern.

    Works with push and pull request events only.

• TAG_NAME

  • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

    Works with RELEASED and PRERELEASED events only.

• RELEASE_NAME

  • A webhook triggers a build when the release name matches the regular expression pattern.

    Works with RELEASED and PRERELEASED events only.

• REPOSITORY_NAME

  • A webhook triggers a build when the repository name matches the regular expression pattern.

    Works with GitHub global or organization webhooks only.

• ORGANIZATION_NAME

  • A webhook triggers a build when the organization name matches the regular expression pattern.

    Works with GitHub global webhooks only.

• WORKFLOW_NAME

  • A webhook triggers a build when the workflow name matches the regular expression pattern.

    Works with WORKFLOW_JOB_QUEUED events only.

    For CodeBuild-hosted Buildkite runner builds, WORKFLOW_NAME filters will filter by pipeline name.

The type of scope for a GitHub or GitLab webhook. The scope default is GITHUB_ORGANIZATION.

The domain of the GitHub Enterprise organization or the GitLab Self Managed group. Note that this parameter is only required if your project's source type is GITHUB_ENTERPRISE or GITLAB_SELF_MANAGED.

The name of either the group, enterprise, or organization that will send webhook events to CodeBuild, depending on the type of webhook.

List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

• DISABLED: Builds trigger automatically without requiring comment approval
• ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)
• FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

A message associated with the status of a webhook.

The status of the webhook. Valid values include:

• CREATING: The webhook is being created.
• CREATE_FAILED: The webhook has failed to create.
• ACTIVE: The webhook has succeeded and is active.
• DELETING: The webhook is being deleted.

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

A timestamp that indicates the last time a repository's secret token was modified.

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

manualCreation is only available for GitHub webhooks.

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

The CodeBuild endpoint where webhook events are sent.

The URL to the webhook.

A list of one or more security groups IDs in your Amazon VPC.

A list of one or more subnet IDs in your Amazon VPC.

The ID of the Amazon VPC.

Information about a repository's webhook that is associated with a project in CodeBuild.

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

The name of the CodeBuild project.

A boolean value that specifies if the results of a report are encrypted.

The encryption key for the report's encrypted raw data.

The type of build output artifact to create. Valid values include:

• NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
• ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.

The path to the exported report's raw data results.

The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.

The name of the S3 bucket where the raw data of a report are exported.

A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.

The export configuration type. Valid values are:

• S3: The report results are exported to an S3 bucket.
• NO_EXPORT: The report results are not exported.

The tag's value.

The tag's key.

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE The report group is active.

DELETING The report group is in the process of being deleted.

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

The date and time this ReportGroup was last modified.

The date and time this ReportGroup was created.

Information about the destination where the raw data of this ReportGroup is exported.

The type of the ReportGroup. This can be one of the following values:

CODE_COVERAGE The report group contains code coverage reports.

TEST The report group contains test reports.

The name of the ReportGroup.

The ARN of the ReportGroup.

Information about the updated report group.

An updated list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

Used to specify an updated export type. Valid values are:

• S3: The report results are exported to an S3 bucket.
• NO_EXPORT: The report results are not exported.

The ARN of the report group to update.

Contains the project identifier used with the public build APIs.

The Amazon Resource Name (ARN) of the build project.

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

The Amazon Resource Name (ARN) of the build project.

Set to true to fetch Git submodules for your CodeBuild build project.

The resource value that applies to the specified authorization type.

The authorization type to use. Valid options are OAUTH, CODECONNECTIONS, or SECRETS_MANAGER.

Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

Enable this flag to ignore SSL warnings while connecting to the project source code.

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an 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.

Information about the authorization settings for CodeBuild to access the source code to be built.

The buildspec file declaration to use for the builds in this build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in 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.

Information about the Git submodules configuration for the build project.

Information about the Git clone depth for the build project.

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 CodePipeline, 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.

• For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,

  https://git-codecommit..amazonaws.com/v1/repos/

  ).

• For source code in an Amazon S3 input bucket, one of the following.

  • The path to the ZIP file that contains the source code (for example,

    //.zip

    ).

  • The path to the folder that contains the source code (for example,

    ///

    ).

• For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
• For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object's type value to CODECONNECTIONS in the source object.
• For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

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 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 repository.
• GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
• GITLAB: The source code is in a GitLab repository.
• GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.
• NO_SOURCE: The project does not have input source code.
• S3: The source code is in an Amazon S3 bucket.

The source version for the corresponding source identifier. If specified, must be one of:

• For CodeCommit: the commit ID, branch, or Git tag 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 GitLab: the commit ID, branch, or Git tag to use.
• 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 S3: the version ID of the object that represents the build input ZIP file to use.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

An identifier for this artifact definition.

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.

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.

The type of build output artifact to create:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of 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: 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.

Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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//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/

  .

Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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//MyArtifact.zip

.

Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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.

Information about the build output artifact location:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of 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.

The type of build output artifact. Valid values include:

• 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.

Defines the scope of the cache. You can use this namespace to share a cache across multiple projects. For more information, see Cache sharing between projects in the CodeBuild User Guide.

An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.

Possible values are:

LOCAL_SOURCE_CACHE 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 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 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 overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.
• S3: This is the S3 bucket name/prefix.

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.

The EC2 instance type to be launched in your fleet.

The machine type of the instance type included in your fleet.

The amount of disk space of the instance type included in your fleet.

The amount of memory of the instance type included in your fleet.

The number of vCPUs of the instance type included in your fleet.

Specifies the compute fleet ARN for the build project.

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
• PLAINTEXT: An environment variable in plain text format. This is the default value.
• SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

The name or key of the environment variable.

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.

A message associated with the status of a docker server.

The status of the docker server.

A DockerServerStatus object to use for this docker server.

Note that status is only an output and cannot be passed in as an input.

A list of one or more security groups IDs.

Security groups configured for Docker servers should allow ingress network traffic from the VPC configured in the project. They should allow ingress on port 9876.

Information about the compute resources the docker server uses. Available values include:

• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for your docker server.
• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for your docker server.
• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for your docker server.
• BUILD_GENERAL1_XLARGE: Use up to 64 GiB memory and 32 vCPUs for your docker server.
• BUILD_GENERAL1_2XLARGE: Use up to 128 GiB memory and 64 vCPUs for your docker server.

The host operating system kernel used for on-demand builds in the build project. The host kernel does not affect the build environment operating system, which is determined by the image you specify. Valid values are:

• LINUX_KERNEL_4: Runs on an Amazon Linux 2 host (kernel 4.x).
• LINUX_KERNEL_6: Runs on an Amazon Linux 2023 host (kernel 6.x).
• LINUX_KERNEL_LATEST: Runs on the latest supported host kernel.

This setting applies to the LINUX_CONTAINER, ARM_CONTAINER, LINUX_EC2, and ARM_EC2 environment types. It is not applicable to Windows, Lambda, or Mac environment types.

A DockerServer object to use for this build project.

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

• 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.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

The credentials for access to a private registry.

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is 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"

A set of environment variables to make available to builds for this build project.

A ProjectFleet object to use for this build project.

The compute configuration of the build project. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

Information about the compute resources the build project uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

  If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.

• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
• BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
• For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
• For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:

• For an image tag:

  /:

  . For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.

• For an image digest:

  /\@

  . For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use

  /\@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf

  .

For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.

The type of build environment to use for related builds.

If you're using compute fleets during project creation, type will be ignored.

For more information, see Build environment compute types in the CodeBuild user guide.

The publicly-accessible URL through which you can access the build badge for your project.

Set this to true to generate a publicly accessible URL for your project's build badge.

The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

• ENABLED: CloudWatch Logs are enabled for this build project.
• DISABLED: CloudWatch Logs are not enabled for this build project.

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

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.

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.

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.

The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.

The identifier is used to mount your file system.

The location in the container where you mount the file system.

A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

The type of the file system. The one supported type is EFS.

An array of strings that specify the fleets that are allowed for the batch build. See Run builds on reserved capacity fleets in the CodeBuild User Guide for more information.

An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.

Specifies the maximum number of builds allowed.

Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.

REPORT_AGGREGATED_BATCH (Default) Aggregate all of the build statuses into a single status report.

REPORT_INDIVIDUAL_BUILDS Send a separate status report for each individual build.

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

A BatchRestrictions object that specifies the restrictions for the batch build.

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

Specifies the service role ARN for the batch build project.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Contains the project identifier used with the public build APIs.

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

A ProjectBuildBatchConfig object that defines the batch build options for the project.

An array of 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.

Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

Information about the build badge for the build project.

Information about the VPC configuration that CodeBuild accesses.

Information about a webhook that connects repository events to a build project in CodeBuild.

When the build project's settings were last modified, expressed in Unix time format.

When the build project was created, expressed in Unix time format.

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format

alias/

). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

The number of minutes a build is allowed to be queued before it times out.

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

Information about the build environment for this build project.

Information about the cache for the build project.

An array of ProjectArtifacts objects.

Information about the build output artifacts for the build project.

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag 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 GitLab: the commit ID, branch, or Git tag to use.
• 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 S3: the version ID of the object that represents the build input ZIP file to use.

If 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.

An array of ProjectSource objects.

Information about the build input source code for this build project.

A description that makes the build project easy to identify.

The Amazon Resource Name (ARN) of the build project.

The name of the build project.

Information about the build project that was changed.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

An array of 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.

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

Set this to true to generate a publicly accessible URL for your project's build badge.

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format

alias/

).

The number of minutes a build is allowed to be queued before it times out.

The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

Information to be changed about the build environment for the build project.

Stores recently used information so that it can be quickly accessed at a later time.

An array of ProjectArtifact objects.

Information to be changed about the build output artifacts for the build project.

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag 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 GitLab: the commit ID, branch, or Git tag to use.
• 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 S3: the version ID of the object that represents the build input ZIP file to use.

If 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.

An array of ProjectSource objects.

Information to be changed about the build input source code for the build project.

A new or replacement description of the build project.

The name of the build project.

You cannot change a build project's name.

A message associated with the status of a compute fleet.

Additional information about a compute fleet. Valid values include:

• CREATE_FAILED: The compute fleet has failed to create.
• UPDATE_FAILED: The compute fleet has failed to update.

The status code of the compute fleet. Valid values include:

• CREATING: The compute fleet is being created.
• UPDATING: The compute fleet is being updated.
• ROTATING: The compute fleet is being rotated.
• PENDING_DELETION: The compute fleet is pending deletion.
• DELETING: The compute fleet is being deleted.
• CREATE_FAILED: The compute fleet has failed to create.
• UPDATE_ROLLBACK_FAILED: The compute fleet has failed to update and could not rollback to previous state.
• ACTIVE: The compute fleet has succeeded and is active.

The value of metricType when to start scaling.

The metric type to determine auto-scaling.

The desired number of instances in the fleet when auto-scaling.

The maximum number of instances in the fleet when auto-scaling.

A list of TargetTrackingScalingConfiguration objects.

The scaling type for a compute fleet.

The destination of the proxy rule.

The behavior of the proxy rule.

The type of proxy rule.

An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.

The default behavior of outgoing traffic.

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

The Amazon Machine Image (AMI) of the compute fleet.

The proxy configuration of the compute fleet.

The compute fleet overflow behavior.

• For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.

• For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.

  If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

The scaling configuration of the compute fleet.

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.

Information about the compute resources the compute fleet uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

  If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.

• CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
• BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
• For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
• For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

The environment type of the compute fleet.

• The environment type 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 (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
• The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
• The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)
• The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).
• The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
• The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

The status of the compute fleet.

The time at which the compute fleet was last modified.

The time at which the compute fleet was created.

The ID of the compute fleet.

The name of the compute fleet.

The ARN of the compute fleet.

A Fleet object.

The maximum number of instances in the fleet when auto-scaling.

A list of TargetTrackingScalingConfiguration objects.

The scaling type for a compute fleet.

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

The Amazon Machine Image (AMI) of the compute fleet.

The proxy configuration of the compute fleet.

The compute fleet overflow behavior.

• For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.

• For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.

  If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

The scaling configuration of the compute fleet.

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.

Information about the compute resources the compute fleet uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.

  If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.

• CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
• BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
• BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
• BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
• BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
• BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
• For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
• For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

The environment type of the compute fleet.

• The environment type 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 (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
• The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
• The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)
• The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).
• The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
• The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
• The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

The ARN of the compute fleet.

The number of nanoseconds it took to run all of the test cases in this report.

A map that contains the number of each type of status returned by the test results in this TestReportSummary.

The number of test cases in this TestReportSummary. The total includes truncated test cases.

The name of the test suite that the test case is a part of.

The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.

A message associated with a test case. For example, an error message or stack trace.

The number of nanoseconds it took to run this test case.

The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.

The name of the test case.

A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.

The path to the raw data file that contains the test result.

The ARN of the report to which the test case belongs.

A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned.

The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:

• SUCCEEDED
• FAILED
• ERROR
• SKIPPED
• UNKNOWN

An explanation of the build phase's context. This might include a command ID and an exit code.

The status code for the context of the build phase.

An array of PhaseContext objects.

How long, in seconds, between the starting and ending times of the sandbox's phase.

When the sandbox phase ended, expressed in Unix time format.

When the sandbox phase started, expressed in Unix time format.

The current status of the sandbox phase. Valid values include:

FAILED The sandbox phase failed.

FAULT The sandbox phase faulted.

IN_PROGRESS The sandbox phase is still in progress.

STOPPED The sandbox phase stopped.

SUCCEEDED The sandbox phase succeeded.

TIMED_OUT The sandbox phase timed out.

The name of the sandbox phase.

Information about S3 logs for a build project.

Information about CloudWatch Logs for a build project.

The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.

The ARN of the CloudWatch Logs stream for a build execution. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. The CloudWatch Logs stream is created during the PROVISIONING phase of a build and the ARN will not be valid until it is created. For more information, see Resources Defined by CloudWatch Logs.

The URL to a build log in an S3 bucket.

The URL to an individual build log in CloudWatch Logs. The log stream is created during the PROVISIONING phase of a build and the deeplink will not be valid until it is created.

The name of the CloudWatch Logs stream for the build logs.

The name of the CloudWatch Logs group for the build logs.

The ID of the network interface.

The ID of the subnet.

An identifier for the version of this sandbox's source code.

An array of SandboxSessionPhase objects.

The current phase for the sandbox.

When the sandbox session ended, expressed in Unix time format.

When the sandbox session started, expressed in Unix time format.

The status of the sandbox session.

The ID of the sandbox session.

The current session for the sandbox.

The name of a service role used for this sandbox.

The Key Management Service customer master key (CMK) to be used for encrypting the sandbox output artifacts.

The number of minutes a sandbox is allowed to be queued before it times out.

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this sandbox if it does not get marked as completed.

An array of 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.

An array of ProjectSourceVersion objects.

An array of ProjectSource objects.

Any version identifier for the version of the sandbox to be built.

The status of the sandbox.

When the sandbox process ended, expressed in Unix time format.

When the sandbox process started, expressed in Unix time format.

When the sandbox process was initially requested, expressed in Unix time format.

The CodeBuild project name.

The ARN of the sandbox.

The ID of the sandbox.

Information about the requested sandbox.

Information about the requested sandbox ID.

Additional information about a build phase, especially to help troubleshoot a failed build.

How long, in seconds, between the starting and ending times of the build's phase.

When the build phase ended, expressed in Unix time format.

When the build phase started, expressed in Unix time format.

The current status of the build phase. Valid values include:

FAILED The build phase failed.

FAULT The build phase faulted.

IN_PROGRESS The build phase is still in progress.

STOPPED The build phase stopped.

SUCCEEDED The build phase succeeded.

TIMED_OUT The build phase timed out.

The name of the build phase. Valid values include:

BUILD Core build activities typically occur in this build phase.

COMPLETED The build has been completed.

DOWNLOAD_SOURCE Source code is being downloaded in this build phase.

FINALIZING The build process is completing in this build phase.

INSTALL Installation activities typically occur in this build phase.

POST_BUILD Post-build activities typically occur in this build phase.

PRE_BUILD Pre-build activities typically occur in this build phase.

PROVISIONING The build environment is being set up.

QUEUED The build has been submitted and is queued behind other submitted builds.

SUBMITTED The build has been submitted.

UPLOAD_ARTIFACTS Build output artifacts are being uploaded to the output location.

An identifier for this artifact definition.

Information that tells you if encryption for build artifacts is disabled.

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.

The MD5 hash of the build artifact.

You can use this hash along with a checksum tool to confirm file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

The SHA-256 hash of the build artifact.

You can use this hash along with a checksum tool to confirm file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

Information about the location of the build artifacts.

The value assigned to the exported environment variable.

The name of the exported environment variable.

Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.

Specifies if session debugging is enabled for this build.

The build ARN of the build that triggered the current auto-retry build. The previous auto-retry will be null for the initial build.

The build ARN of the auto-retried build triggered by the current build. The next auto-retry will be null for builds that don't trigger an auto-retry.

The number of times that the build has been retried. The initial build will have an auto-retry number of 0.

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

Information about the auto-retry configuration for the build.

The ARN of the batch build that this build is a member of, if applicable.

Contains information about the debug session for this build.

An array of 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.

An array of the ARNs associated with this build's reports.

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format

alias/

).

Describes a network interface.

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

The entity that started the build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
• If a user started the build, the user's name (for example, MyUserName).
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Whether the build is complete. True if complete; otherwise, false.

The number of minutes a build is allowed to be queued before it times out.

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.

Information about the build's logs in CloudWatch Logs.

The name of a service role used for this build.

Information about the build environment for this build.

Information about the cache for the build.

An array of ProjectArtifacts objects.

Information about the output artifacts for the build.

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag 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 S3: the version ID of the object that represents the build input ZIP file to use.

An array of ProjectSource objects.

Information about the source code to be built.

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

The name of the CodeBuild project.

An identifier for the version of this build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
• For CodePipeline, the source revision provided by CodePipeline.
• For Amazon S3, this does not apply.

Any version identifier for the version of the source code to be built. 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 CodeBuild User Guide.

The current status of the build. Valid values include:

• FAILED: The build failed.
• FAULT: The build faulted.
• IN_PROGRESS: The build is still in progress.
• STOPPED: The build stopped.
• SUCCEEDED: The build succeeded.
• TIMED_OUT: The build timed out.

The current build phase.

When the build process ended, expressed in Unix time format.

When the build process started, expressed in Unix time format.

The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.

The Amazon Resource Name (ARN) of the build.

The unique ID for the build.

Information about the build.

The ID of the build.

Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.

How long, in seconds, between the starting and ending times of the batch build's phase.

When the batch build phase ended, expressed in Unix time format.

When the batch build phase started, expressed in Unix time format.

The current status of the batch build phase. Valid values include:

FAILED The build phase failed.

FAULT The build phase faulted.

IN_PROGRESS The build phase is still in progress.

STOPPED The build phase stopped.

SUCCEEDED The build phase succeeded.

TIMED_OUT The build phase timed out.

The name of the batch build phase. Valid values include:

COMBINE_ARTIFACTS Build output artifacts are being combined and uploaded to the output location.

DOWNLOAD_BATCHSPEC The batch build specification is being downloaded.

FAILED One or more of the builds failed.

IN_PROGRESS The batch build is in progress.

STOPPED The batch build was stopped.

SUBMITTED The btach build has been submitted.

SUCCEEDED The batch build succeeded.

The identifier of the artifact.

The location of the artifact.

Specifies the type of artifact.

An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.

A ResolvedArtifact object that represents the primary build artifacts for the build group.

The status of the build group.

FAILED The build group failed.

FAULT The build group faulted.

IN_PROGRESS The build group is still in progress.

STOPPED The build group stopped.

SUCCEEDED The build group succeeded.

TIMED_OUT The build group timed out.

When the build was started, expressed in Unix time format.

The batch build ARN.

An array of BuildSummary objects that contain summaries of previous build groups.

A BuildSummary object that contains a summary of the current build group.

Specifies if failures in this build group can be ignored.

An array of strings that contain the identifiers of the build groups that this build group depends on.

Contains the identifier of the build group.

An array that contains the ARNs of reports created by merging reports from builds associated with this batch build.

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

An array of BuildGroup objects that define the build groups for the batch build.

An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format

alias/

).

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
• If a user started the build, the user's name.
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Indicates if the batch build is complete.

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

The name of a service role used for builds in the batch.

An array of BuildArtifacts objects the define the build artifacts for this batch build.

A BuildArtifacts object the defines the build artifacts for this batch build.

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag 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 S3: the version ID of the object that represents the build input ZIP file to use.

An array of ProjectSource objects that define the sources for the batch build.

An array of BuildBatchPhase objects the specify the phases of the batch build.

The name of the batch build project.

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
• For CodePipeline, the source revision provided by CodePipeline.
• For Amazon S3, this does not apply.

The identifier of the version of the source code to be built.

The status of the batch build.

The current phase of the batch build.

The date and time that the batch build ended.

The date and time that the batch build started.