Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Auto
Retry Config Information about the auto-retry configuration for the build.
- Batch
Restrictions Specifies restrictions for the batch build.
- Build
Information about a build.
- Build
Artifacts Information about build output artifacts.
- Build
Batch Contains information about a batch build.
- Build
Batch Filter Specifies filters when retrieving batch builds.
- Build
Batch Phase Contains information about a stage for a batch build.
- Build
Group Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
- Build
NotDeleted Information about a build that could not be successfully deleted.
- Build
Phase Information about a stage for a build.
- Build
Status Config Contains information that defines how the CodeBuild build project reports the build status to the source provider.
- Build
Summary Contains summary information about a batch build group.
- Cloud
Watch Logs Config Information about CloudWatch Logs for a build project.
- Code
Coverage Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an
if
orcase
statement.- Code
Coverage Report Summary Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an
if
orcase
statement.- Command
Execution Contains command execution information.
- Compute
Configuration Contains compute attributes. These attributes only need be specified when your project's or fleet's
computeType
is set toATTRIBUTE_BASED_COMPUTE
orCUSTOM_INSTANCE_TYPE
.- Debug
Session Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
- Docker
Server Contains docker server information.
- Docker
Server Status Contains information about the status of the docker server.
- Environment
Image Information about a Docker image that is managed by CodeBuild.
- Environment
Language A set of Docker images that are related by programming language and are managed by CodeBuild.
- Environment
Platform A set of Docker images that are related by platform and are managed by CodeBuild.
- Environment
Variable Information about an environment variable for a build project or a build.
- Exported
Environment Variable Contains information about an exported environment variable.
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.
During a build, the value of a variable is available starting with the
install
phase. It can be updated between the start of theinstall
phase and the end of thepost_build
phase. After thepost_build
phase ends, the value of exported variables cannot change.- Fleet
A set of dedicated instances for your build environment.
- Fleet
Proxy Rule Information about the proxy rule for your reserved capacity instances.
- Fleet
Status The status of the compute fleet.
- GitSubmodules
Config Information about the Git submodules configuration for an CodeBuild build project.
- Logs
Config Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
- Logs
Location Information about build logs in CloudWatch Logs.
- Network
Interface Describes a network interface.
- Phase
Context Additional information about a build phase that has an error. You can use this information for troubleshooting.
- Project
Information about a build project.
- Project
Artifacts Information about the build output artifacts for the build project.
- Project
Badge Information about the build badge for the build project.
- Project
Build Batch Config Contains configuration information about a batch build project.
- Project
Cache Information about the cache for the build project.
- Project
Environment Information about the build environment of the build project.
- Project
File System Location Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
- Project
Fleet Information about the compute fleet of the build project. For more information, see Working with reserved capacity in CodeBuild.
- Project
Source Information about the build input source code for the build project.
- Project
Source Version A source identifier and its corresponding version.
- Proxy
Configuration Information about the proxy configurations that apply network access control to your reserved capacity instances.
- Registry
Credential Information about credentials that provide access to a private Docker registry. When this is set:
-
imagePullCredentialsType
must be set toSERVICE_ROLE
. -
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
-
- Report
Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
- Report
Export Config Information about the location where the run of a report is exported.
- Report
Filter A filter used to return reports with the status specified by the input
status
parameter.- Report
Group A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
- Report
Group Trend Stats Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
- Report
With RawData Contains the unmodified data for the report. For more information, see .
- Resolved
Artifact Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
- S3Logs
Config Information about S3 logs for a build project.
- S3Report
Export Config Information about the S3 bucket where the raw data of a report are exported.
- Sandbox
Contains sandbox information.
- Sandbox
Session Contains information about the sandbox session.
- Sandbox
Session Phase Contains information about the sandbox phase.
- Scaling
Configuration Input The scaling configuration input of a compute fleet.
- Scaling
Configuration Output The scaling configuration output of a compute fleet.
- Scope
Configuration Contains configuration information about the scope for a webhook.
- Source
Auth Information about the authorization settings for CodeBuild to access the source code to be built.
- Source
Credentials Info Information about the credentials for a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.
- SsmSession
Contains information about the Session Manager session.
- Tag
A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
- Target
Tracking Scaling Configuration Defines when a new instance is auto-scaled into the compute fleet.
- Test
Case Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
- Test
Case Filter A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.
- Test
Report Summary Information about a test report.
- VpcConfig
Information about the VPC configuration that CodeBuild accesses.
- Webhook
Information about a webhook that connects repository events to a build project in CodeBuild.
- Webhook
Filter A filter used to determine which webhooks trigger a build.
Enums§
- Artifact
Namespace - When writing a match expression against
ArtifactNamespace
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Artifact
Packaging - When writing a match expression against
ArtifactPackaging
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Artifacts
Type - When writing a match expression against
ArtifactsType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auth
Type - When writing a match expression against
AuthType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Batch
Report Mode Type - When writing a match expression against
BatchReportModeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Bucket
Owner Access - When writing a match expression against
BucketOwnerAccess
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Build
Batch Phase Type - When writing a match expression against
BuildBatchPhaseType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Build
Phase Type - When writing a match expression against
BuildPhaseType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Mode - When writing a match expression against
CacheMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Type - When writing a match expression against
CacheType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Command
Type - When writing a match expression against
CommandType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Compute
Type - When writing a match expression against
ComputeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Credential
Provider Type - When writing a match expression against
CredentialProviderType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Environment
Type - When writing a match expression against
EnvironmentType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Environment
Variable Type - When writing a match expression against
EnvironmentVariableType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - File
System Type - When writing a match expression against
FileSystemType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Context Code - When writing a match expression against
FleetContextCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Overflow Behavior - When writing a match expression against
FleetOverflowBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Proxy Rule Behavior - When writing a match expression against
FleetProxyRuleBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Proxy Rule Effect Type - When writing a match expression against
FleetProxyRuleEffectType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Proxy Rule Type - When writing a match expression against
FleetProxyRuleType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Scaling Metric Type - When writing a match expression against
FleetScalingMetricType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Scaling Type - When writing a match expression against
FleetScalingType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Sort ByType - When writing a match expression against
FleetSortByType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fleet
Status Code - When writing a match expression against
FleetStatusCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Image
Pull Credentials Type - When writing a match expression against
ImagePullCredentialsType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Language
Type - When writing a match expression against
LanguageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Logs
Config Status Type - When writing a match expression against
LogsConfigStatusType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Machine
Type - When writing a match expression against
MachineType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Platform
Type - When writing a match expression against
PlatformType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Project
Sort ByType - When writing a match expression against
ProjectSortByType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Project
Visibility Type - When writing a match expression against
ProjectVisibilityType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Code Coverage Sort ByType - When writing a match expression against
ReportCodeCoverageSortByType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Export Config Type - When writing a match expression against
ReportExportConfigType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Group Sort ByType - When writing a match expression against
ReportGroupSortByType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Group Status Type - When writing a match expression against
ReportGroupStatusType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Group Trend Field Type - When writing a match expression against
ReportGroupTrendFieldType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Packaging Type - When writing a match expression against
ReportPackagingType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Status Type - When writing a match expression against
ReportStatusType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Report
Type - When writing a match expression against
ReportType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Retry
Build Batch Type - When writing a match expression against
RetryBuildBatchType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Server
Type - When writing a match expression against
ServerType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Shared
Resource Sort ByType - When writing a match expression against
SharedResourceSortByType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Sort
Order Type - When writing a match expression against
SortOrderType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Auth Type - When writing a match expression against
SourceAuthType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Type - When writing a match expression against
SourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Status
Type - When writing a match expression against
StatusType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Webhook
Build Type - When writing a match expression against
WebhookBuildType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Webhook
Filter Type - When writing a match expression against
WebhookFilterType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Webhook
Scope Type - When writing a match expression against
WebhookScopeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Webhook
Status - When writing a match expression against
WebhookStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.