String id
The build's unique ID.
String arn
The build's Amazon Resource Name (ARN).
Date startTime
When the build process started, expressed in Unix time format.
Date endTime
When the build process ended, expressed in Unix time format.
String currentPhase
The build's current build phase.
String buildStatus
The build's current status. 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.
String sourceVersion
Any version identifier for the version of the source code to be built.
String projectName
The build project's name.
List<E> phases
Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.
ProjectSource source
Information about the source code to be built.
BuildArtifacts artifacts
Information about the build's output artifacts.
ProjectEnvironment environment
Information about the build environment for this build.
LogsLocation logs
Information about the build's logs in Amazon CloudWatch Logs.
Integer timeoutInMinutes
How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.
Boolean buildComplete
Whether the build has finished. Valid values include true if completed; otherwise, false.
String initiator
The entity that started the build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name, for example
codepipeline/my-demo-pipeline.
If an AWS Identity and Access Management (IAM) user started the build, the user's name, for example
MyUserName.
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
String location
Information about the build artifacts' location.
String sha256sum
The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
This value is available only if the related build project's packaging value is set to
ZIP.
String md5sum
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
This value is available only if the related build project's packaging value is set to
ZIP.
String phaseType
The build phase's name. Valid values include:
BUILD: Core build activities typically occur in this build phase.
COMPLETED: The build has 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.
SUBMITTED: The build has been submitted.
UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to output location.
String phaseStatus
The build phase's current status. 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.
Date startTime
When the build phase started, expressed in Unix time format.
Date endTime
When the build phase ended, expressed in Unix time format.
Long durationInSeconds
How long, in seconds, between the build's phase starting and ending times.
List<E> contexts
Additional information about a build phase, especially to help troubleshoot a failed build.
String name
The build project's name.
String description
A meaningful description of the build project.
ProjectSource source
Information about the build project's build input source code.
ProjectArtifacts artifacts
Information about the build project's build output artifacts.
ProjectEnvironment environment
Information about the build project's build environment.
String serviceRole
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
String encryptionKey
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format
alias/alias-name ).
List<E> tags
A set of tags for this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
Project project
Information about the build project that was created.
String name
The name of the build project to delete.
String projectName
The name of the build project to get a list of build IDs for.
String sortOrder
The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
List<E> ids
A list of build IDs for the specified build project, with each build ID representing a single build.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
String sortOrder
The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
List<E> ids
A list of build IDs, with each build ID representing a single build.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
String sortBy
The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List the build project names based on when each build project was created.
LAST_MODIFIED_TIME: List the build project names based on when information about each build project
was last changed.
NAME: List the build project names based on each build project's name.
Use sortOrder to specify in what order to list the build project names based on the preceding
criteria.
String sortOrder
The order in which to list build projects. Valid values include:
ASCENDING: List the build project names in ascending order.
DESCENDING: List the build project names in descending order.
Use sortBy to specify the criterion to be used to list build project names.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
List<E> projects
The list of build project names, with each build project name representing a single build project.
String name
The build project's name.
String arn
The build project's Amazon Resource Name (ARN).
String description
A meaningful description of the build project.
ProjectSource source
Information about the build project's build input source code.
ProjectArtifacts artifacts
Information about the build project's build output artifacts.
ProjectEnvironment environment
Information about the build environment for this build project.
String serviceRole
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed. The default is 60 minutes.
String encryptionKey
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the
format alias/alias-name ).
List<E> tags
The tags for this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
Date created
When the build project was created, expressed in Unix time format.
Date lastModified
When the build project's settings were last modified, expressed in Unix time format.
String type
The build output artifact's type. Valid values include:
CODEPIPELINE: The build project with have build output generated through AWS CodePipeline.
NO_ARTIFACTS: The build project will not produce any build output.
S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).
String location
Information about the build output artifact location, as follows:
If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if
specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because
no build output will be produced.
If type is set to S3, this is the name of the output bucket. If path is
not also specified, then location can also specify the path of the output artifact in the output
bucket.
String path
Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and
store the output artifact, as follows:
If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if
specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because
no build output will be produced.
If type is set to S3, this is the path to the output artifact. If path is
not specified, then path will not be used.
For example, if path is set to MyArtifacts, namespaceType is set to
NONE, and name is set to MyArtifact.zip, then the output artifact would be
stored in the output bucket at MyArtifacts/MyArtifact.zip.
String namespaceType
Along with path and name, the pattern that AWS CodeBuild will use to determine the name
and location to store the output artifact, as follows:
If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if
specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because
no build output will be produced.
If type is set to S3, then valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not
specified.
For example, if path is set to MyArtifacts, namespaceType is set to
BUILD_ID, and name is set to MyArtifact.zip, then the output artifact
would be stored in MyArtifacts/build-ID/MyArtifact.zip.
String name
Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and
store the output artifact, as follows:
If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if
specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because
no build output will be produced.
If type is set to S3, this is the name of the output artifact object.
For example, if path is set to MyArtifacts, namespaceType is set to
BUILD_ID, and name is set to MyArtifact.zip, then the output artifact
would be stored in MyArtifacts/build-ID/MyArtifact.zip.
String packaging
The type of build output artifact to create, as follows:
If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if
specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because
no build output will be produced.
If type is set to S3, valid values include:
NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is
the default if packaging is not specified.
ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
String type
The type of build environment to use for related builds.
The only valid value is LINUX_CONTAINER, which represents a Linux-based build environment.
String image
The ID of the Docker image to use for this build project.
String computeType
Information about the compute resources the build project will use. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.
List<E> environmentVariables
A set of environment variables to make available to builds for this build project.
String type
The type of repository that contains the source code to be built. Valid values include:
CODECOMMIT: The source code is in an AWS CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB: The source code is in a GitHub repository.
S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
String location
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 AWS CodePipeline,
location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is
because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source
code and the build spec (for example,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that
contains the source code (for example,
bucket-name/path/to/object-name.zip)
For source code in a GitHub repository, the HTTPS clone URL, including the user name and personal access token,
to the repository that contains the source code and the build spec (for example,
https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git
). For more information, see Creating an Access Token
for Command-Line Use on the GitHub Help website.
String buildspec
The build spec declaration to use for this build project's related builds.
If this value is not specified, a build spec must be included along with the source code to be built.
SourceAuth auth
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
String projectName
The name of the build project to start running a build.
String sourceVersion
A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:
For AWS CodeCommit or GitHub: the commit ID to use.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.
ProjectArtifacts artifactsOverride
Build output artifact settings that override, for this build only, the latest ones already defined in the corresponding build project.
List<E> environmentVariablesOverride
A set of environment variables that overrides, for this build only, the latest ones already defined in the corresponding build project.
String buildspecOverride
A build spec declaration that overrides, for this build only, the latest one already defined in the corresponding build project.
Integer timeoutInMinutesOverride
The number of build timeout minutes, from 5 to 480 (8 hours) that overrides, for this build only, the latest setting already defined in the corresponding build project.
Build build
Information about the build to be run.
String id
The ID of the build to attempt to stop running.
Build build
Information about the build that was attempted to be stopped.
String name
The name of the existing build project to change settings.
You cannot change an existing build project's name.
String description
A new or replacement description of the build project.
ProjectSource source
Information to be changed about the build project's build input source code.
ProjectArtifacts artifacts
Information to be changed about the build project's build output artifacts.
ProjectEnvironment environment
Information to be changed about the build project's build environment.
String serviceRole
The replacement Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait to timeout any related build that did not get marked as completed.
String encryptionKey
The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format
alias/alias-name ).
List<E> tags
The replacement set of tags for this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
Project project
Information about the build project that was changed.
Copyright © 2017. All rights reserved.