builds

Creates, updates, deletes, gets or lists a builds resource.

Overview

Name	builds
Type	Resource
Id	aws.codebuild.builds

Fields

The following fields are returned by SELECT queries:

batch_get_builds

Name	Datatype	Description
builds	array	Information about the requested builds.
builds_not_found	array	The IDs of builds for which information could not be found.

list_builds

Name	Datatype	Description
id	string	A list of build IDs, with each build ID representing a single build.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_builds	select	region		Gets information about one or more builds.
list_builds	select	region		Gets a list of build IDs, with each build ID representing a single build.
batch_delete_builds	exec	region, ids		Deletes one or more builds.
start_build_batch	exec	region, projectName		Starts a batch build for a project.
stop_build_batch	exec	region, id		Stops a running batch build.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_builds

Gets information about one or more builds.

SELECT
builds,
builds_not_found
FROM aws.codebuild.builds
WHERE region = '{{ region }}' -- required
;

list_builds

Gets a list of build IDs, with each build ID representing a single build.

SELECT
id
FROM aws.codebuild.builds
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

batch_delete_builds

Deletes one or more builds.

EXEC aws.codebuild.builds.batch_delete_builds 
@region='{{ region }}' --required 
@@json=
'{
"ids": "{{ ids }}"
}'
;

start_build_batch

Starts a batch build for a project.

EXEC aws.codebuild.builds.start_build_batch 
@region='{{ region }}' --required 
@@json=
'{
"projectName": "{{ projectName }}", 
"secondarySourcesOverride": "{{ secondarySourcesOverride }}", 
"secondarySourcesVersionOverride": "{{ secondarySourcesVersionOverride }}", 
"sourceVersion": "{{ sourceVersion }}", 
"artifactsOverride": "{{ artifactsOverride }}", 
"secondaryArtifactsOverride": "{{ secondaryArtifactsOverride }}", 
"environmentVariablesOverride": "{{ environmentVariablesOverride }}", 
"sourceTypeOverride": "{{ sourceTypeOverride }}", 
"sourceLocationOverride": "{{ sourceLocationOverride }}", 
"sourceAuthOverride": "{{ sourceAuthOverride }}", 
"gitCloneDepthOverride": {{ gitCloneDepthOverride }}, 
"gitSubmodulesConfigOverride": "{{ gitSubmodulesConfigOverride }}", 
"buildspecOverride": "{{ buildspecOverride }}", 
"insecureSslOverride": {{ insecureSslOverride }}, 
"reportBuildBatchStatusOverride": {{ reportBuildBatchStatusOverride }}, 
"environmentTypeOverride": "{{ environmentTypeOverride }}", 
"imageOverride": "{{ imageOverride }}", 
"computeTypeOverride": "{{ computeTypeOverride }}", 
"certificateOverride": "{{ certificateOverride }}", 
"cacheOverride": "{{ cacheOverride }}", 
"serviceRoleOverride": "{{ serviceRoleOverride }}", 
"privilegedModeOverride": {{ privilegedModeOverride }}, 
"buildTimeoutInMinutesOverride": {{ buildTimeoutInMinutesOverride }}, 
"queuedTimeoutInMinutesOverride": {{ queuedTimeoutInMinutesOverride }}, 
"encryptionKeyOverride": "{{ encryptionKeyOverride }}", 
"idempotencyToken": "{{ idempotencyToken }}", 
"logsConfigOverride": "{{ logsConfigOverride }}", 
"registryCredentialOverride": "{{ registryCredentialOverride }}", 
"imagePullCredentialsTypeOverride": "{{ imagePullCredentialsTypeOverride }}", 
"buildBatchConfigOverride": "{{ buildBatchConfigOverride }}", 
"debugSessionEnabled": {{ debugSessionEnabled }}
}'
;

stop_build_batch

Stops a running batch build.

EXEC aws.codebuild.builds.stop_build_batch 
@region='{{ region }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;