UNPKG

82.1 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CodeBuild extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CodeBuild.Types.ClientConfiguration)
13 config: Config & CodeBuild.Types.ClientConfiguration;
14 /**
15 * Deletes one or more builds.
16 */
17 batchDeleteBuilds(params: CodeBuild.Types.BatchDeleteBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>;
18 /**
19 * Deletes one or more builds.
20 */
21 batchDeleteBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>;
22 /**
23 * Gets information about builds.
24 */
25 batchGetBuilds(params: CodeBuild.Types.BatchGetBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
26 /**
27 * Gets information about builds.
28 */
29 batchGetBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
30 /**
31 * Gets information about build projects.
32 */
33 batchGetProjects(params: CodeBuild.Types.BatchGetProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
34 /**
35 * Gets information about build projects.
36 */
37 batchGetProjects(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
38 /**
39 * Creates a build project.
40 */
41 createProject(params: CodeBuild.Types.CreateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
42 /**
43 * Creates a build project.
44 */
45 createProject(callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
46 /**
47 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
48 */
49 createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
50 /**
51 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
52 */
53 createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
54 /**
55 * Deletes a build project.
56 */
57 deleteProject(params: CodeBuild.Types.DeleteProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
58 /**
59 * Deletes a build project.
60 */
61 deleteProject(callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
62 /**
63 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
64 */
65 deleteSourceCredentials(params: CodeBuild.Types.DeleteSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
66 /**
67 * Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
68 */
69 deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
70 /**
71 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
72 */
73 deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
74 /**
75 * For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
76 */
77 deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
78 /**
79 * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
80 */
81 importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
82 /**
83 * Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
84 */
85 importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
86 /**
87 * Resets the cache for a project.
88 */
89 invalidateProjectCache(params: CodeBuild.Types.InvalidateProjectCacheInput, callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
90 /**
91 * Resets the cache for a project.
92 */
93 invalidateProjectCache(callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
94 /**
95 * Gets a list of build IDs, with each build ID representing a single build.
96 */
97 listBuilds(params: CodeBuild.Types.ListBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
98 /**
99 * Gets a list of build IDs, with each build ID representing a single build.
100 */
101 listBuilds(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
102 /**
103 * Gets a list of build IDs for the specified build project, with each build ID representing a single build.
104 */
105 listBuildsForProject(params: CodeBuild.Types.ListBuildsForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
106 /**
107 * Gets a list of build IDs for the specified build project, with each build ID representing a single build.
108 */
109 listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
110 /**
111 * Gets information about Docker images that are managed by AWS CodeBuild.
112 */
113 listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
114 /**
115 * Gets information about Docker images that are managed by AWS CodeBuild.
116 */
117 listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
118 /**
119 * Gets a list of build project names, with each build project name representing a single build project.
120 */
121 listProjects(params: CodeBuild.Types.ListProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
122 /**
123 * Gets a list of build project names, with each build project name representing a single build project.
124 */
125 listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
126 /**
127 * Returns a list of SourceCredentialsInfo objects.
128 */
129 listSourceCredentials(params: CodeBuild.Types.ListSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
130 /**
131 * Returns a list of SourceCredentialsInfo objects.
132 */
133 listSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
134 /**
135 * Starts running a build.
136 */
137 startBuild(params: CodeBuild.Types.StartBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
138 /**
139 * Starts running a build.
140 */
141 startBuild(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
142 /**
143 * Attempts to stop running a build.
144 */
145 stopBuild(params: CodeBuild.Types.StopBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
146 /**
147 * Attempts to stop running a build.
148 */
149 stopBuild(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
150 /**
151 * Changes the settings of a build project.
152 */
153 updateProject(params: CodeBuild.Types.UpdateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
154 /**
155 * Changes the settings of a build project.
156 */
157 updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
158 /**
159 * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
160 */
161 updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
162 /**
163 * Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
164 */
165 updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
166}
167declare namespace CodeBuild {
168 export type ArtifactNamespace = "NONE"|"BUILD_ID"|string;
169 export type ArtifactPackaging = "NONE"|"ZIP"|string;
170 export type ArtifactsType = "CODEPIPELINE"|"S3"|"NO_ARTIFACTS"|string;
171 export type AuthType = "OAUTH"|"BASIC_AUTH"|"PERSONAL_ACCESS_TOKEN"|string;
172 export interface BatchDeleteBuildsInput {
173 /**
174 * The IDs of the builds to delete.
175 */
176 ids: BuildIds;
177 }
178 export interface BatchDeleteBuildsOutput {
179 /**
180 * The IDs of the builds that were successfully deleted.
181 */
182 buildsDeleted?: BuildIds;
183 /**
184 * Information about any builds that could not be successfully deleted.
185 */
186 buildsNotDeleted?: BuildsNotDeleted;
187 }
188 export interface BatchGetBuildsInput {
189 /**
190 * The IDs of the builds.
191 */
192 ids: BuildIds;
193 }
194 export interface BatchGetBuildsOutput {
195 /**
196 * Information about the requested builds.
197 */
198 builds?: Builds;
199 /**
200 * The IDs of builds for which information could not be found.
201 */
202 buildsNotFound?: BuildIds;
203 }
204 export interface BatchGetProjectsInput {
205 /**
206 * The names of the build projects.
207 */
208 names: ProjectNames;
209 }
210 export interface BatchGetProjectsOutput {
211 /**
212 * Information about the requested build projects.
213 */
214 projects?: Projects;
215 /**
216 * The names of build projects for which information could not be found.
217 */
218 projectsNotFound?: ProjectNames;
219 }
220 export type Boolean = boolean;
221 export interface Build {
222 /**
223 * The unique ID for the build.
224 */
225 id?: NonEmptyString;
226 /**
227 * The Amazon Resource Name (ARN) of the build.
228 */
229 arn?: NonEmptyString;
230 /**
231 * When the build process started, expressed in Unix time format.
232 */
233 startTime?: Timestamp;
234 /**
235 * When the build process ended, expressed in Unix time format.
236 */
237 endTime?: Timestamp;
238 /**
239 * The current build phase.
240 */
241 currentPhase?: String;
242 /**
243 * 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.
244 */
245 buildStatus?: StatusType;
246 /**
247 * 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 AWS CodeBuild User Guide.
248 */
249 sourceVersion?: NonEmptyString;
250 /**
251 * An identifier for the version of this build's source code. For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For AWS CodePipeline, the source revision provided by AWS CodePipeline. For Amazon Simple Storage Service (Amazon S3), this does not apply.
252 */
253 resolvedSourceVersion?: NonEmptyString;
254 /**
255 * The name of the AWS CodeBuild project.
256 */
257 projectName?: NonEmptyString;
258 /**
259 * Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
260 */
261 phases?: BuildPhases;
262 /**
263 * Information about the source code to be built.
264 */
265 source?: ProjectSource;
266 /**
267 * An array of ProjectSource objects.
268 */
269 secondarySources?: ProjectSources;
270 /**
271 * An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For AWS CodeCommit: the commit ID 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
272 */
273 secondarySourceVersions?: ProjectSecondarySourceVersions;
274 /**
275 * Information about the output artifacts for the build.
276 */
277 artifacts?: BuildArtifacts;
278 /**
279 * An array of ProjectArtifacts objects.
280 */
281 secondaryArtifacts?: BuildArtifactsList;
282 /**
283 * Information about the cache for the build.
284 */
285 cache?: ProjectCache;
286 /**
287 * Information about the build environment for this build.
288 */
289 environment?: ProjectEnvironment;
290 /**
291 * The name of a service role used for this build.
292 */
293 serviceRole?: NonEmptyString;
294 /**
295 * Information about the build's logs in Amazon CloudWatch Logs.
296 */
297 logs?: LogsLocation;
298 /**
299 * How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
300 */
301 timeoutInMinutes?: WrapperInt;
302 /**
303 * The number of minutes a build is allowed to be queued before it times out.
304 */
305 queuedTimeoutInMinutes?: WrapperInt;
306 /**
307 * Whether the build is complete. True if complete; otherwise, false.
308 */
309 buildComplete?: Boolean;
310 /**
311 * 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.
312 */
313 initiator?: String;
314 /**
315 * If your AWS 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.
316 */
317 vpcConfig?: VpcConfig;
318 /**
319 * Describes a network interface.
320 */
321 networkInterface?: NetworkInterface;
322 /**
323 * The AWS Key Management Service (AWS KMS) 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/alias-name ).
324 */
325 encryptionKey?: NonEmptyString;
326 }
327 export interface BuildArtifacts {
328 /**
329 * Information about the location of the build artifacts.
330 */
331 location?: String;
332 /**
333 * 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.
334 */
335 sha256sum?: String;
336 /**
337 * 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.
338 */
339 md5sum?: String;
340 /**
341 * If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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.
342 */
343 overrideArtifactName?: WrapperBoolean;
344 /**
345 * Information that tells you if encryption for build artifacts is disabled.
346 */
347 encryptionDisabled?: WrapperBoolean;
348 /**
349 * An identifier for this artifact definition.
350 */
351 artifactIdentifier?: String;
352 }
353 export type BuildArtifactsList = BuildArtifacts[];
354 export type BuildIds = NonEmptyString[];
355 export interface BuildNotDeleted {
356 /**
357 * The ID of the build that could not be successfully deleted.
358 */
359 id?: NonEmptyString;
360 /**
361 * Additional information about the build that could not be successfully deleted.
362 */
363 statusCode?: String;
364 }
365 export interface BuildPhase {
366 /**
367 * 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.
368 */
369 phaseType?: BuildPhaseType;
370 /**
371 * 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. QUEUED: The build has been submitted and is queued behind other submitted builds. STOPPED: The build phase stopped. SUCCEEDED: The build phase succeeded. TIMED_OUT: The build phase timed out.
372 */
373 phaseStatus?: StatusType;
374 /**
375 * When the build phase started, expressed in Unix time format.
376 */
377 startTime?: Timestamp;
378 /**
379 * When the build phase ended, expressed in Unix time format.
380 */
381 endTime?: Timestamp;
382 /**
383 * How long, in seconds, between the starting and ending times of the build's phase.
384 */
385 durationInSeconds?: WrapperLong;
386 /**
387 * Additional information about a build phase, especially to help troubleshoot a failed build.
388 */
389 contexts?: PhaseContexts;
390 }
391 export type BuildPhaseType = "SUBMITTED"|"QUEUED"|"PROVISIONING"|"DOWNLOAD_SOURCE"|"INSTALL"|"PRE_BUILD"|"BUILD"|"POST_BUILD"|"UPLOAD_ARTIFACTS"|"FINALIZING"|"COMPLETED"|string;
392 export type BuildPhases = BuildPhase[];
393 export type Builds = Build[];
394 export type BuildsNotDeleted = BuildNotDeleted[];
395 export type CacheMode = "LOCAL_DOCKER_LAYER_CACHE"|"LOCAL_SOURCE_CACHE"|"LOCAL_CUSTOM_CACHE"|string;
396 export type CacheType = "NO_CACHE"|"S3"|"LOCAL"|string;
397 export interface CloudWatchLogsConfig {
398 /**
399 * The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: ENABLED: Amazon CloudWatch Logs are enabled for this build project. DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
400 */
401 status: LogsConfigStatusType;
402 /**
403 * The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
404 */
405 groupName?: String;
406 /**
407 * The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
408 */
409 streamName?: String;
410 }
411 export type ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|string;
412 export interface CreateProjectInput {
413 /**
414 * The name of the build project.
415 */
416 name: ProjectName;
417 /**
418 * A description that makes the build project easy to identify.
419 */
420 description?: ProjectDescription;
421 /**
422 * Information about the build input source code for the build project.
423 */
424 source: ProjectSource;
425 /**
426 * An array of ProjectSource objects.
427 */
428 secondarySources?: ProjectSources;
429 /**
430 * 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 AWS CodeCommit: the commit ID 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 Simple Storage Service (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 AWS CodeBuild User Guide.
431 */
432 sourceVersion?: String;
433 /**
434 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
435 */
436 secondarySourceVersions?: ProjectSecondarySourceVersions;
437 /**
438 * Information about the build output artifacts for the build project.
439 */
440 artifacts: ProjectArtifacts;
441 /**
442 * An array of ProjectArtifacts objects.
443 */
444 secondaryArtifacts?: ProjectArtifactsList;
445 /**
446 * Stores recently used information so that it can be quickly accessed at a later time.
447 */
448 cache?: ProjectCache;
449 /**
450 * Information about the build environment for the build project.
451 */
452 environment: ProjectEnvironment;
453 /**
454 * The 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.
455 */
456 serviceRole: NonEmptyString;
457 /**
458 * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
459 */
460 timeoutInMinutes?: TimeOut;
461 /**
462 * The number of minutes a build is allowed to be queued before it times out.
463 */
464 queuedTimeoutInMinutes?: TimeOut;
465 /**
466 * The AWS Key Management Service (AWS KMS) 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/alias-name ).
467 */
468 encryptionKey?: NonEmptyString;
469 /**
470 * A set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
471 */
472 tags?: TagList;
473 /**
474 * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
475 */
476 vpcConfig?: VpcConfig;
477 /**
478 * Set this to true to generate a publicly accessible URL for your project's build badge.
479 */
480 badgeEnabled?: WrapperBoolean;
481 /**
482 * Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
483 */
484 logsConfig?: LogsConfig;
485 }
486 export interface CreateProjectOutput {
487 /**
488 * Information about the build project that was created.
489 */
490 project?: Project;
491 }
492 export interface CreateWebhookInput {
493 /**
494 * The name of the AWS CodeBuild project.
495 */
496 projectName: ProjectName;
497 /**
498 * 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.
499 */
500 branchFilter?: String;
501 /**
502 * 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.
503 */
504 filterGroups?: FilterGroups;
505 }
506 export interface CreateWebhookOutput {
507 /**
508 * Information about a webhook that connects repository events to a build project in AWS CodeBuild.
509 */
510 webhook?: Webhook;
511 }
512 export type CredentialProviderType = "SECRETS_MANAGER"|string;
513 export interface DeleteProjectInput {
514 /**
515 * The name of the build project.
516 */
517 name: NonEmptyString;
518 }
519 export interface DeleteProjectOutput {
520 }
521 export interface DeleteSourceCredentialsInput {
522 /**
523 * The Amazon Resource Name (ARN) of the token.
524 */
525 arn: NonEmptyString;
526 }
527 export interface DeleteSourceCredentialsOutput {
528 /**
529 * The Amazon Resource Name (ARN) of the token.
530 */
531 arn?: NonEmptyString;
532 }
533 export interface DeleteWebhookInput {
534 /**
535 * The name of the AWS CodeBuild project.
536 */
537 projectName: ProjectName;
538 }
539 export interface DeleteWebhookOutput {
540 }
541 export interface EnvironmentImage {
542 /**
543 * The name of the Docker image.
544 */
545 name?: String;
546 /**
547 * The description of the Docker image.
548 */
549 description?: String;
550 /**
551 * A list of environment image versions.
552 */
553 versions?: ImageVersions;
554 }
555 export type EnvironmentImages = EnvironmentImage[];
556 export interface EnvironmentLanguage {
557 /**
558 * The programming language for the Docker images.
559 */
560 language?: LanguageType;
561 /**
562 * The list of Docker images that are related by the specified programming language.
563 */
564 images?: EnvironmentImages;
565 }
566 export type EnvironmentLanguages = EnvironmentLanguage[];
567 export interface EnvironmentPlatform {
568 /**
569 * The platform's name.
570 */
571 platform?: PlatformType;
572 /**
573 * The list of programming languages that are available for the specified platform.
574 */
575 languages?: EnvironmentLanguages;
576 }
577 export type EnvironmentPlatforms = EnvironmentPlatform[];
578 export type EnvironmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|string;
579 export interface EnvironmentVariable {
580 /**
581 * The name or key of the environment variable.
582 */
583 name: NonEmptyString;
584 /**
585 * The value of the environment variable. We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).
586 */
587 value: String;
588 /**
589 * The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. PLAINTEXT: An environment variable in plaintext format.
590 */
591 type?: EnvironmentVariableType;
592 }
593 export type EnvironmentVariableType = "PLAINTEXT"|"PARAMETER_STORE"|string;
594 export type EnvironmentVariables = EnvironmentVariable[];
595 export type FilterGroup = WebhookFilter[];
596 export type FilterGroups = FilterGroup[];
597 export type GitCloneDepth = number;
598 export interface GitSubmodulesConfig {
599 /**
600 * Set to true to fetch Git submodules for your AWS CodeBuild build project.
601 */
602 fetchSubmodules: WrapperBoolean;
603 }
604 export type ImagePullCredentialsType = "CODEBUILD"|"SERVICE_ROLE"|string;
605 export type ImageVersions = String[];
606 export interface ImportSourceCredentialsInput {
607 /**
608 * The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
609 */
610 username?: NonEmptyString;
611 /**
612 * For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
613 */
614 token: SensitiveNonEmptyString;
615 /**
616 * The source provider used for this project.
617 */
618 serverType: ServerType;
619 /**
620 * The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.
621 */
622 authType: AuthType;
623 /**
624 * Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
625 */
626 shouldOverwrite?: WrapperBoolean;
627 }
628 export interface ImportSourceCredentialsOutput {
629 /**
630 * The Amazon Resource Name (ARN) of the token.
631 */
632 arn?: NonEmptyString;
633 }
634 export interface InvalidateProjectCacheInput {
635 /**
636 * The name of the AWS CodeBuild build project that the cache is reset for.
637 */
638 projectName: NonEmptyString;
639 }
640 export interface InvalidateProjectCacheOutput {
641 }
642 export type KeyInput = string;
643 export type LanguageType = "JAVA"|"PYTHON"|"NODE_JS"|"RUBY"|"GOLANG"|"DOCKER"|"ANDROID"|"DOTNET"|"BASE"|"PHP"|string;
644 export interface ListBuildsForProjectInput {
645 /**
646 * The name of the AWS CodeBuild project.
647 */
648 projectName: NonEmptyString;
649 /**
650 * 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.
651 */
652 sortOrder?: SortOrderType;
653 /**
654 * 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.
655 */
656 nextToken?: String;
657 }
658 export interface ListBuildsForProjectOutput {
659 /**
660 * A list of build IDs for the specified build project, with each build ID representing a single build.
661 */
662 ids?: BuildIds;
663 /**
664 * 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.
665 */
666 nextToken?: String;
667 }
668 export interface ListBuildsInput {
669 /**
670 * 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.
671 */
672 sortOrder?: SortOrderType;
673 /**
674 * 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.
675 */
676 nextToken?: String;
677 }
678 export interface ListBuildsOutput {
679 /**
680 * A list of build IDs, with each build ID representing a single build.
681 */
682 ids?: BuildIds;
683 /**
684 * 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.
685 */
686 nextToken?: String;
687 }
688 export interface ListCuratedEnvironmentImagesInput {
689 }
690 export interface ListCuratedEnvironmentImagesOutput {
691 /**
692 * Information about supported platforms for Docker images that are managed by AWS CodeBuild.
693 */
694 platforms?: EnvironmentPlatforms;
695 }
696 export interface ListProjectsInput {
697 /**
698 * The criterion to be used to list build project names. Valid values include: CREATED_TIME: List based on when each build project was created. LAST_MODIFIED_TIME: List based on when information about each build project was last changed. NAME: List 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.
699 */
700 sortBy?: ProjectSortByType;
701 /**
702 * The order in which to list build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order. Use sortBy to specify the criterion to be used to list build project names.
703 */
704 sortOrder?: SortOrderType;
705 /**
706 * 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.
707 */
708 nextToken?: NonEmptyString;
709 }
710 export interface ListProjectsOutput {
711 /**
712 * 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.
713 */
714 nextToken?: String;
715 /**
716 * The list of build project names, with each build project name representing a single build project.
717 */
718 projects?: ProjectNames;
719 }
720 export interface ListSourceCredentialsInput {
721 }
722 export interface ListSourceCredentialsOutput {
723 /**
724 * A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
725 */
726 sourceCredentialsInfos?: SourceCredentialsInfos;
727 }
728 export interface LogsConfig {
729 /**
730 * Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.
731 */
732 cloudWatchLogs?: CloudWatchLogsConfig;
733 /**
734 * Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
735 */
736 s3Logs?: S3LogsConfig;
737 }
738 export type LogsConfigStatusType = "ENABLED"|"DISABLED"|string;
739 export interface LogsLocation {
740 /**
741 * The name of the Amazon CloudWatch Logs group for the build logs.
742 */
743 groupName?: String;
744 /**
745 * The name of the Amazon CloudWatch Logs stream for the build logs.
746 */
747 streamName?: String;
748 /**
749 * The URL to an individual build log in Amazon CloudWatch Logs.
750 */
751 deepLink?: String;
752 /**
753 * The URL to a build log in an S3 bucket.
754 */
755 s3DeepLink?: String;
756 /**
757 * Information about Amazon CloudWatch Logs for a build project.
758 */
759 cloudWatchLogs?: CloudWatchLogsConfig;
760 /**
761 * Information about S3 logs for a build project.
762 */
763 s3Logs?: S3LogsConfig;
764 }
765 export interface NetworkInterface {
766 /**
767 * The ID of the subnet.
768 */
769 subnetId?: NonEmptyString;
770 /**
771 * The ID of the network interface.
772 */
773 networkInterfaceId?: NonEmptyString;
774 }
775 export type NonEmptyString = string;
776 export interface PhaseContext {
777 /**
778 * The status code for the context of the build phase.
779 */
780 statusCode?: String;
781 /**
782 * An explanation of the build phase's context. This might include a command ID and an exit code.
783 */
784 message?: String;
785 }
786 export type PhaseContexts = PhaseContext[];
787 export type PlatformType = "DEBIAN"|"AMAZON_LINUX"|"UBUNTU"|"WINDOWS_SERVER"|string;
788 export interface Project {
789 /**
790 * The name of the build project.
791 */
792 name?: ProjectName;
793 /**
794 * The Amazon Resource Name (ARN) of the build project.
795 */
796 arn?: String;
797 /**
798 * A description that makes the build project easy to identify.
799 */
800 description?: ProjectDescription;
801 /**
802 * Information about the build input source code for this build project.
803 */
804 source?: ProjectSource;
805 /**
806 * An array of ProjectSource objects.
807 */
808 secondarySources?: ProjectSources;
809 /**
810 * 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 AWS CodeCommit: the commit ID 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 Simple Storage Service (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 AWS CodeBuild User Guide.
811 */
812 sourceVersion?: String;
813 /**
814 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
815 */
816 secondarySourceVersions?: ProjectSecondarySourceVersions;
817 /**
818 * Information about the build output artifacts for the build project.
819 */
820 artifacts?: ProjectArtifacts;
821 /**
822 * An array of ProjectArtifacts objects.
823 */
824 secondaryArtifacts?: ProjectArtifactsList;
825 /**
826 * Information about the cache for the build project.
827 */
828 cache?: ProjectCache;
829 /**
830 * Information about the build environment for this build project.
831 */
832 environment?: ProjectEnvironment;
833 /**
834 * The 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.
835 */
836 serviceRole?: NonEmptyString;
837 /**
838 * How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
839 */
840 timeoutInMinutes?: TimeOut;
841 /**
842 * The number of minutes a build is allowed to be queued before it times out.
843 */
844 queuedTimeoutInMinutes?: TimeOut;
845 /**
846 * The AWS Key Management Service (AWS KMS) 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/alias-name ).
847 */
848 encryptionKey?: NonEmptyString;
849 /**
850 * The tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
851 */
852 tags?: TagList;
853 /**
854 * When the build project was created, expressed in Unix time format.
855 */
856 created?: Timestamp;
857 /**
858 * When the build project's settings were last modified, expressed in Unix time format.
859 */
860 lastModified?: Timestamp;
861 /**
862 * Information about a webhook that connects repository events to a build project in AWS CodeBuild.
863 */
864 webhook?: Webhook;
865 /**
866 * Information about the VPC configuration that AWS CodeBuild accesses.
867 */
868 vpcConfig?: VpcConfig;
869 /**
870 * Information about the build badge for the build project.
871 */
872 badge?: ProjectBadge;
873 /**
874 * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
875 */
876 logsConfig?: LogsConfig;
877 }
878 export interface ProjectArtifacts {
879 /**
880 * The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through AWS CodePipeline. NO_ARTIFACTS: The build project does not produce any build output. S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
881 */
882 type: ArtifactsType;
883 /**
884 * Information about the build output artifact location: If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, 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.
885 */
886 location?: String;
887 /**
888 * Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, 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.
889 */
890 path?: String;
891 /**
892 * Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, 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/build-ID/MyArtifact.zip.
893 */
894 namespaceType?: ArtifactNamespace;
895 /**
896 * Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, 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/build-ID/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/build-ID .
897 */
898 name?: String;
899 /**
900 * The type of build output artifact to create: If type is set to CODEPIPELINE, AWS CodePipeline ignores 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, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
901 */
902 packaging?: ArtifactPackaging;
903 /**
904 * If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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.
905 */
906 overrideArtifactName?: WrapperBoolean;
907 /**
908 * Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.
909 */
910 encryptionDisabled?: WrapperBoolean;
911 /**
912 * An identifier for this artifact definition.
913 */
914 artifactIdentifier?: String;
915 }
916 export type ProjectArtifactsList = ProjectArtifacts[];
917 export interface ProjectBadge {
918 /**
919 * Set this to true to generate a publicly accessible URL for your project's build badge.
920 */
921 badgeEnabled?: Boolean;
922 /**
923 * The publicly-accessible URL through which you can access the build badge for your project. The publicly accessible URL through which you can access the build badge for your project.
924 */
925 badgeRequestUrl?: String;
926 }
927 export interface ProjectCache {
928 /**
929 * 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.
930 */
931 type: CacheType;
932 /**
933 * Information about the cache location: NO_CACHE or LOCAL: This value is ignored. S3: This is the S3 bucket name/prefix.
934 */
935 location?: String;
936 /**
937 * If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time. LOCAL_SOURCE_CACHE mode 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 mode 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 mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
938 */
939 modes?: ProjectCacheModes;
940 }
941 export type ProjectCacheModes = CacheMode[];
942 export type ProjectDescription = string;
943 export interface ProjectEnvironment {
944 /**
945 * The type of build environment to use for related builds.
946 */
947 type: EnvironmentType;
948 /**
949 * 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: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest. For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
950 */
951 image: NonEmptyString;
952 /**
953 * Information about the compute resources the build project uses. 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.
954 */
955 computeType: ComputeType;
956 /**
957 * A set of environment variables to make available to builds for this build project.
958 */
959 environmentVariables?: EnvironmentVariables;
960 /**
961 * 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. 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&amp; - 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&amp; - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
962 */
963 privilegedMode?: WrapperBoolean;
964 /**
965 * The certificate to use with this build project.
966 */
967 certificate?: String;
968 /**
969 * The credentials for access to a private registry.
970 */
971 registryCredential?: RegistryCredential;
972 /**
973 * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.
974 */
975 imagePullCredentialsType?: ImagePullCredentialsType;
976 }
977 export type ProjectName = string;
978 export type ProjectNames = NonEmptyString[];
979 export type ProjectSecondarySourceVersions = ProjectSourceVersion[];
980 export type ProjectSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string;
981 export interface ProjectSource {
982 /**
983 * 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 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. NO_SOURCE: The project does not have input source code. S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
984 */
985 type: SourceType;
986 /**
987 * 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 ignores 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, one of the following. The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip). The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/). For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS 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 AWS 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 AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS 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 AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
988 */
989 location?: String;
990 /**
991 * Information about the Git clone depth for the build project.
992 */
993 gitCloneDepth?: GitCloneDepth;
994 /**
995 * Information about the Git submodules configuration for the build project.
996 */
997 gitSubmodulesConfig?: GitSubmodulesConfig;
998 /**
999 * The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built.
1000 */
1001 buildspec?: String;
1002 /**
1003 * Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
1004 */
1005 auth?: SourceAuth;
1006 /**
1007 * 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, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
1008 */
1009 reportBuildStatus?: WrapperBoolean;
1010 /**
1011 * Enable this flag to ignore SSL warnings while connecting to the project source code.
1012 */
1013 insecureSsl?: WrapperBoolean;
1014 /**
1015 * An identifier for this project source.
1016 */
1017 sourceIdentifier?: String;
1018 }
1019 export interface ProjectSourceVersion {
1020 /**
1021 * An identifier for a source in the build project.
1022 */
1023 sourceIdentifier: String;
1024 /**
1025 * The source version for the corresponding source identifier. If specified, must be one of: For AWS CodeCommit: the commit ID 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 Simple Storage Service (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 AWS CodeBuild User Guide.
1026 */
1027 sourceVersion: String;
1028 }
1029 export type ProjectSources = ProjectSource[];
1030 export type Projects = Project[];
1031 export interface RegistryCredential {
1032 /**
1033 * The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The credential can use the name of the credentials only if they exist in your current region.
1034 */
1035 credential: NonEmptyString;
1036 /**
1037 * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
1038 */
1039 credentialProvider: CredentialProviderType;
1040 }
1041 export interface S3LogsConfig {
1042 /**
1043 * 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.
1044 */
1045 status: LogsConfigStatusType;
1046 /**
1047 * 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.
1048 */
1049 location?: String;
1050 /**
1051 * Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
1052 */
1053 encryptionDisabled?: WrapperBoolean;
1054 }
1055 export type SecurityGroupIds = NonEmptyString[];
1056 export type SensitiveNonEmptyString = string;
1057 export type ServerType = "GITHUB"|"BITBUCKET"|"GITHUB_ENTERPRISE"|string;
1058 export type SortOrderType = "ASCENDING"|"DESCENDING"|string;
1059 export interface SourceAuth {
1060 /**
1061 * This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.
1062 */
1063 type: SourceAuthType;
1064 /**
1065 * The resource value that applies to the specified authorization type.
1066 */
1067 resource?: String;
1068 }
1069 export type SourceAuthType = "OAUTH"|string;
1070 export interface SourceCredentialsInfo {
1071 /**
1072 * The Amazon Resource Name (ARN) of the token.
1073 */
1074 arn?: NonEmptyString;
1075 /**
1076 * The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
1077 */
1078 serverType?: ServerType;
1079 /**
1080 * The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
1081 */
1082 authType?: AuthType;
1083 }
1084 export type SourceCredentialsInfos = SourceCredentialsInfo[];
1085 export type SourceType = "CODECOMMIT"|"CODEPIPELINE"|"GITHUB"|"S3"|"BITBUCKET"|"GITHUB_ENTERPRISE"|"NO_SOURCE"|string;
1086 export interface StartBuildInput {
1087 /**
1088 * The name of the AWS CodeBuild build project to start running a build.
1089 */
1090 projectName: NonEmptyString;
1091 /**
1092 * An array of ProjectSource objects.
1093 */
1094 secondarySourcesOverride?: ProjectSources;
1095 /**
1096 * An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
1097 */
1098 secondarySourcesVersionOverride?: ProjectSecondarySourceVersions;
1099 /**
1100 * A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of: For AWS CodeCommit: the commit ID 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. 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 AWS CodeBuild User Guide.
1101 */
1102 sourceVersion?: String;
1103 /**
1104 * Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
1105 */
1106 artifactsOverride?: ProjectArtifacts;
1107 /**
1108 * An array of ProjectArtifacts objects.
1109 */
1110 secondaryArtifactsOverride?: ProjectArtifactsList;
1111 /**
1112 * A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
1113 */
1114 environmentVariablesOverride?: EnvironmentVariables;
1115 /**
1116 * A source input type, for this build, that overrides the source input defined in the build project.
1117 */
1118 sourceTypeOverride?: SourceType;
1119 /**
1120 * A location that overrides, for this build, the source location for the one defined in the build project.
1121 */
1122 sourceLocationOverride?: String;
1123 /**
1124 * An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
1125 */
1126 sourceAuthOverride?: SourceAuth;
1127 /**
1128 * The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
1129 */
1130 gitCloneDepthOverride?: GitCloneDepth;
1131 /**
1132 * Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
1133 */
1134 gitSubmodulesConfigOverride?: GitSubmodulesConfig;
1135 /**
1136 * A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
1137 */
1138 buildspecOverride?: String;
1139 /**
1140 * Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
1141 */
1142 insecureSslOverride?: WrapperBoolean;
1143 /**
1144 * Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
1145 */
1146 reportBuildStatusOverride?: WrapperBoolean;
1147 /**
1148 * A container type for this build that overrides the one specified in the build project.
1149 */
1150 environmentTypeOverride?: EnvironmentType;
1151 /**
1152 * The name of an image for this build that overrides the one specified in the build project.
1153 */
1154 imageOverride?: NonEmptyString;
1155 /**
1156 * The name of a compute type for this build that overrides the one specified in the build project.
1157 */
1158 computeTypeOverride?: ComputeType;
1159 /**
1160 * The name of a certificate for this build that overrides the one specified in the build project.
1161 */
1162 certificateOverride?: String;
1163 /**
1164 * A ProjectCache object specified for this build that overrides the one defined in the build project.
1165 */
1166 cacheOverride?: ProjectCache;
1167 /**
1168 * The name of a service role for this build that overrides the one specified in the build project.
1169 */
1170 serviceRoleOverride?: NonEmptyString;
1171 /**
1172 * Enable this flag to override privileged mode in the build project.
1173 */
1174 privilegedModeOverride?: WrapperBoolean;
1175 /**
1176 * 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 build project.
1177 */
1178 timeoutInMinutesOverride?: TimeOut;
1179 /**
1180 * The number of minutes a build is allowed to be queued before it times out.
1181 */
1182 queuedTimeoutInMinutesOverride?: TimeOut;
1183 /**
1184 * A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
1185 */
1186 idempotencyToken?: String;
1187 /**
1188 * Log settings for this build that override the log settings defined in the build project.
1189 */
1190 logsConfigOverride?: LogsConfig;
1191 /**
1192 * The credentials for access to a private registry.
1193 */
1194 registryCredentialOverride?: RegistryCredential;
1195 /**
1196 * The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
1197 */
1198 imagePullCredentialsTypeOverride?: ImagePullCredentialsType;
1199 }
1200 export interface StartBuildOutput {
1201 /**
1202 * Information about the build to be run.
1203 */
1204 build?: Build;
1205 }
1206 export type StatusType = "SUCCEEDED"|"FAILED"|"FAULT"|"TIMED_OUT"|"IN_PROGRESS"|"STOPPED"|string;
1207 export interface StopBuildInput {
1208 /**
1209 * The ID of the build.
1210 */
1211 id: NonEmptyString;
1212 }
1213 export interface StopBuildOutput {
1214 /**
1215 * Information about the build.
1216 */
1217 build?: Build;
1218 }
1219 export type String = string;
1220 export type Subnets = NonEmptyString[];
1221 export interface Tag {
1222 /**
1223 * The tag's key.
1224 */
1225 key?: KeyInput;
1226 /**
1227 * The tag's value.
1228 */
1229 value?: ValueInput;
1230 }
1231 export type TagList = Tag[];
1232 export type TimeOut = number;
1233 export type Timestamp = Date;
1234 export interface UpdateProjectInput {
1235 /**
1236 * The name of the build project. You cannot change a build project's name.
1237 */
1238 name: NonEmptyString;
1239 /**
1240 * A new or replacement description of the build project.
1241 */
1242 description?: ProjectDescription;
1243 /**
1244 * Information to be changed about the build input source code for the build project.
1245 */
1246 source?: ProjectSource;
1247 /**
1248 * An array of ProjectSource objects.
1249 */
1250 secondarySources?: ProjectSources;
1251 /**
1252 * 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 AWS CodeCommit: the commit ID 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 Simple Storage Service (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 AWS CodeBuild User Guide.
1253 */
1254 sourceVersion?: String;
1255 /**
1256 * An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
1257 */
1258 secondarySourceVersions?: ProjectSecondarySourceVersions;
1259 /**
1260 * Information to be changed about the build output artifacts for the build project.
1261 */
1262 artifacts?: ProjectArtifacts;
1263 /**
1264 * An array of ProjectSource objects.
1265 */
1266 secondaryArtifacts?: ProjectArtifactsList;
1267 /**
1268 * Stores recently used information so that it can be quickly accessed at a later time.
1269 */
1270 cache?: ProjectCache;
1271 /**
1272 * Information to be changed about the build environment for the build project.
1273 */
1274 environment?: ProjectEnvironment;
1275 /**
1276 * The replacement 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.
1277 */
1278 serviceRole?: NonEmptyString;
1279 /**
1280 * The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
1281 */
1282 timeoutInMinutes?: TimeOut;
1283 /**
1284 * The number of minutes a build is allowed to be queued before it times out.
1285 */
1286 queuedTimeoutInMinutes?: TimeOut;
1287 /**
1288 * The AWS Key Management Service (AWS KMS) 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/alias-name ).
1289 */
1290 encryptionKey?: NonEmptyString;
1291 /**
1292 * 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.
1293 */
1294 tags?: TagList;
1295 /**
1296 * VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
1297 */
1298 vpcConfig?: VpcConfig;
1299 /**
1300 * Set this to true to generate a publicly accessible URL for your project's build badge.
1301 */
1302 badgeEnabled?: WrapperBoolean;
1303 /**
1304 * Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.
1305 */
1306 logsConfig?: LogsConfig;
1307 }
1308 export interface UpdateProjectOutput {
1309 /**
1310 * Information about the build project that was changed.
1311 */
1312 project?: Project;
1313 }
1314 export interface UpdateWebhookInput {
1315 /**
1316 * The name of the AWS CodeBuild project.
1317 */
1318 projectName: ProjectName;
1319 /**
1320 * 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.
1321 */
1322 branchFilter?: String;
1323 /**
1324 * 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.
1325 */
1326 rotateSecret?: Boolean;
1327 /**
1328 * An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one EVENT WebhookFilter.
1329 */
1330 filterGroups?: FilterGroups;
1331 }
1332 export interface UpdateWebhookOutput {
1333 /**
1334 * Information about a repository's webhook that is associated with a project in AWS CodeBuild.
1335 */
1336 webhook?: Webhook;
1337 }
1338 export type ValueInput = string;
1339 export interface VpcConfig {
1340 /**
1341 * The ID of the Amazon VPC.
1342 */
1343 vpcId?: NonEmptyString;
1344 /**
1345 * A list of one or more subnet IDs in your Amazon VPC.
1346 */
1347 subnets?: Subnets;
1348 /**
1349 * A list of one or more security groups IDs in your Amazon VPC.
1350 */
1351 securityGroupIds?: SecurityGroupIds;
1352 }
1353 export interface Webhook {
1354 /**
1355 * The URL to the webhook.
1356 */
1357 url?: NonEmptyString;
1358 /**
1359 * The AWS CodeBuild endpoint where webhook events are sent.
1360 */
1361 payloadUrl?: NonEmptyString;
1362 /**
1363 * The secret token of the associated repository. A Bitbucket webhook does not support secret.
1364 */
1365 secret?: NonEmptyString;
1366 /**
1367 * 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.
1368 */
1369 branchFilter?: String;
1370 /**
1371 * 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.
1372 */
1373 filterGroups?: FilterGroups;
1374 /**
1375 * A timestamp that indicates the last time a repository's secret token was modified.
1376 */
1377 lastModifiedSecret?: Timestamp;
1378 }
1379 export interface WebhookFilter {
1380 /**
1381 * The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH. EVENT A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. 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. The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise 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 GitHub and GitHub Enterprise push events only.
1382 */
1383 type: WebhookFilterType;
1384 /**
1385 * 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.
1386 */
1387 pattern: String;
1388 /**
1389 * 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.
1390 */
1391 excludeMatchedPattern?: WrapperBoolean;
1392 }
1393 export type WebhookFilterType = "EVENT"|"BASE_REF"|"HEAD_REF"|"ACTOR_ACCOUNT_ID"|"FILE_PATH"|string;
1394 export type WrapperBoolean = boolean;
1395 export type WrapperInt = number;
1396 export type WrapperLong = number;
1397 /**
1398 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1399 */
1400 export type apiVersion = "2016-10-06"|"latest"|string;
1401 export interface ClientApiVersions {
1402 /**
1403 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1404 */
1405 apiVersion?: apiVersion;
1406 }
1407 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1408 /**
1409 * Contains interfaces for use with the CodeBuild client.
1410 */
1411 export import Types = CodeBuild;
1412}
1413export = CodeBuild;