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