@aws-sdk/client-codebuild 3.408.0 → 3.410.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/runtimeExtensions.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/CodeBuild.d.ts +2 -2
- package/dist-types/CodeBuildClient.d.ts +2 -2
- package/dist-types/commands/BatchGetBuildBatchesCommand.d.ts +26 -26
- package/dist-types/commands/BatchGetBuildsCommand.d.ts +20 -20
- package/dist-types/commands/BatchGetProjectsCommand.d.ts +27 -27
- package/dist-types/commands/BatchGetReportGroupsCommand.d.ts +4 -4
- package/dist-types/commands/BatchGetReportsCommand.d.ts +4 -4
- package/dist-types/commands/CreateProjectCommand.d.ts +51 -51
- package/dist-types/commands/CreateReportGroupCommand.d.ts +7 -7
- package/dist-types/commands/CreateWebhookCommand.d.ts +4 -4
- package/dist-types/commands/DescribeCodeCoveragesCommand.d.ts +2 -2
- package/dist-types/commands/GetReportGroupTrendCommand.d.ts +1 -1
- package/dist-types/commands/ImportSourceCredentialsCommand.d.ts +2 -2
- package/dist-types/commands/ListBuildBatchesCommand.d.ts +2 -2
- package/dist-types/commands/ListBuildBatchesForProjectCommand.d.ts +2 -2
- package/dist-types/commands/ListBuildsCommand.d.ts +1 -1
- package/dist-types/commands/ListBuildsForProjectCommand.d.ts +1 -1
- package/dist-types/commands/ListCuratedEnvironmentImagesCommand.d.ts +2 -2
- package/dist-types/commands/ListProjectsCommand.d.ts +2 -2
- package/dist-types/commands/ListReportGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListReportsCommand.d.ts +2 -2
- package/dist-types/commands/ListReportsForReportGroupCommand.d.ts +2 -2
- package/dist-types/commands/ListSharedProjectsCommand.d.ts +2 -2
- package/dist-types/commands/ListSharedReportGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListSourceCredentialsCommand.d.ts +2 -2
- package/dist-types/commands/RetryBuildBatchCommand.d.ts +27 -27
- package/dist-types/commands/RetryBuildCommand.d.ts +20 -20
- package/dist-types/commands/StartBuildBatchCommand.d.ts +49 -49
- package/dist-types/commands/StartBuildCommand.d.ts +42 -42
- package/dist-types/commands/StopBuildBatchCommand.d.ts +26 -26
- package/dist-types/commands/StopBuildCommand.d.ts +20 -20
- package/dist-types/commands/UpdateProjectCommand.d.ts +51 -51
- package/dist-types/commands/UpdateProjectVisibilityCommand.d.ts +2 -2
- package/dist-types/commands/UpdateReportGroupCommand.d.ts +6 -6
- package/dist-types/commands/UpdateWebhookCommand.d.ts +4 -4
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +486 -489
- package/dist-types/runtimeConfig.browser.d.ts +4 -1
- package/dist-types/runtimeConfig.d.ts +4 -1
- package/dist-types/runtimeConfig.native.d.ts +4 -1
- package/dist-types/runtimeExtensions.d.ts +1 -1
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +8 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -1
- package/dist-types/ts3.4/runtimeExtensions.d.ts +1 -1
- package/package.json +28 -28
|
@@ -151,23 +151,23 @@ export interface BuildArtifacts {
|
|
|
151
151
|
/**
|
|
152
152
|
* @public
|
|
153
153
|
* <p>The SHA-256 hash of the build artifact.</p>
|
|
154
|
-
*
|
|
154
|
+
* <p>You can use this hash along with a checksum tool to confirm file integrity and
|
|
155
155
|
* authenticity.</p>
|
|
156
|
-
*
|
|
156
|
+
* <note>
|
|
157
157
|
* <p>This value is available only if the build project's <code>packaging</code> value
|
|
158
158
|
* is set to <code>ZIP</code>.</p>
|
|
159
|
-
*
|
|
159
|
+
* </note>
|
|
160
160
|
*/
|
|
161
161
|
sha256sum?: string;
|
|
162
162
|
/**
|
|
163
163
|
* @public
|
|
164
164
|
* <p>The MD5 hash of the build artifact.</p>
|
|
165
|
-
*
|
|
165
|
+
* <p>You can use this hash along with a checksum tool to confirm file integrity and
|
|
166
166
|
* authenticity.</p>
|
|
167
|
-
*
|
|
167
|
+
* <note>
|
|
168
168
|
* <p>This value is available only if the build project's <code>packaging</code> value
|
|
169
169
|
* is set to <code>ZIP</code>.</p>
|
|
170
|
-
*
|
|
170
|
+
* </note>
|
|
171
171
|
*/
|
|
172
172
|
md5sum?: string;
|
|
173
173
|
/**
|
|
@@ -194,40 +194,40 @@ export interface BuildArtifacts {
|
|
|
194
194
|
* Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
|
|
195
195
|
* access to these objects. This property allows you to give the bucket owner access to
|
|
196
196
|
* these objects.</p>
|
|
197
|
-
*
|
|
197
|
+
* <note>
|
|
198
198
|
* <p>To use this property, your CodeBuild service role must have the
|
|
199
199
|
* <code>s3:PutBucketAcl</code> permission. This permission allows CodeBuild to modify
|
|
200
200
|
* the access control list for the bucket.</p>
|
|
201
|
-
*
|
|
202
|
-
*
|
|
201
|
+
* </note>
|
|
202
|
+
* <p>This property can be one of the following values:</p>
|
|
203
203
|
* <dl>
|
|
204
204
|
* <dt>NONE</dt>
|
|
205
205
|
* <dd>
|
|
206
|
-
*
|
|
206
|
+
* <p>The bucket owner does not have access to the objects. This is the
|
|
207
207
|
* default.</p>
|
|
208
208
|
* </dd>
|
|
209
209
|
* <dt>READ_ONLY</dt>
|
|
210
210
|
* <dd>
|
|
211
|
-
*
|
|
211
|
+
* <p>The bucket owner has read-only access to the objects. The uploading account
|
|
212
212
|
* retains ownership of the objects.</p>
|
|
213
213
|
* </dd>
|
|
214
214
|
* <dt>FULL</dt>
|
|
215
215
|
* <dd>
|
|
216
|
-
*
|
|
216
|
+
* <p>The bucket owner has full access to the objects. Object ownership is determined
|
|
217
217
|
* by the following criteria:</p>
|
|
218
|
-
*
|
|
218
|
+
* <ul>
|
|
219
219
|
* <li>
|
|
220
|
-
*
|
|
220
|
+
* <p>If the bucket is configured with the <b>Bucket
|
|
221
221
|
* owner preferred</b> setting, the bucket owner owns the
|
|
222
222
|
* objects. The uploading account will have object access as specified
|
|
223
223
|
* by the bucket's policy.</p>
|
|
224
|
-
*
|
|
224
|
+
* </li>
|
|
225
225
|
* <li>
|
|
226
|
-
*
|
|
226
|
+
* <p>Otherwise, the uploading account retains ownership of the
|
|
227
227
|
* objects.</p>
|
|
228
|
-
*
|
|
228
|
+
* </li>
|
|
229
229
|
* </ul>
|
|
230
|
-
*
|
|
230
|
+
* <p>For more information about Amazon S3 object ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of uploaded objects using S3
|
|
231
231
|
* Object Ownership</a> in the <i>Amazon Simple Storage Service User
|
|
232
232
|
* Guide</i>.</p>
|
|
233
233
|
* </dd>
|
|
@@ -367,31 +367,31 @@ export interface BuildSummary {
|
|
|
367
367
|
/**
|
|
368
368
|
* @public
|
|
369
369
|
* <p>The status of the build group.</p>
|
|
370
|
-
*
|
|
370
|
+
* <dl>
|
|
371
371
|
* <dt>FAILED</dt>
|
|
372
372
|
* <dd>
|
|
373
|
-
*
|
|
374
|
-
*
|
|
373
|
+
* <p>The build group failed.</p>
|
|
374
|
+
* </dd>
|
|
375
375
|
* <dt>FAULT</dt>
|
|
376
376
|
* <dd>
|
|
377
|
-
*
|
|
378
|
-
*
|
|
377
|
+
* <p>The build group faulted.</p>
|
|
378
|
+
* </dd>
|
|
379
379
|
* <dt>IN_PROGRESS</dt>
|
|
380
380
|
* <dd>
|
|
381
|
-
*
|
|
382
|
-
*
|
|
381
|
+
* <p>The build group is still in progress.</p>
|
|
382
|
+
* </dd>
|
|
383
383
|
* <dt>STOPPED</dt>
|
|
384
384
|
* <dd>
|
|
385
|
-
*
|
|
386
|
-
*
|
|
385
|
+
* <p>The build group stopped.</p>
|
|
386
|
+
* </dd>
|
|
387
387
|
* <dt>SUCCEEDED</dt>
|
|
388
388
|
* <dd>
|
|
389
|
-
*
|
|
390
|
-
*
|
|
389
|
+
* <p>The build group succeeded.</p>
|
|
390
|
+
* </dd>
|
|
391
391
|
* <dt>TIMED_OUT</dt>
|
|
392
392
|
* <dd>
|
|
393
|
-
*
|
|
394
|
-
*
|
|
393
|
+
* <p>The build group timed out.</p>
|
|
394
|
+
* </dd>
|
|
395
395
|
* </dl>
|
|
396
396
|
*/
|
|
397
397
|
buildStatus?: StatusType | string;
|
|
@@ -478,17 +478,17 @@ export interface ProjectCache {
|
|
|
478
478
|
/**
|
|
479
479
|
* @public
|
|
480
480
|
* <p>The type of cache used by the build project. Valid values include:</p>
|
|
481
|
-
*
|
|
481
|
+
* <ul>
|
|
482
482
|
* <li>
|
|
483
|
-
*
|
|
483
|
+
* <p>
|
|
484
484
|
* <code>NO_CACHE</code>: The build project does not use any cache.</p>
|
|
485
485
|
* </li>
|
|
486
486
|
* <li>
|
|
487
|
-
*
|
|
487
|
+
* <p>
|
|
488
488
|
* <code>S3</code>: The build project reads and writes from and to S3.</p>
|
|
489
489
|
* </li>
|
|
490
490
|
* <li>
|
|
491
|
-
*
|
|
491
|
+
* <p>
|
|
492
492
|
* <code>LOCAL</code>: The build project stores a cache locally on a build host
|
|
493
493
|
* that is only available to that build host.</p>
|
|
494
494
|
* </li>
|
|
@@ -498,13 +498,13 @@ export interface ProjectCache {
|
|
|
498
498
|
/**
|
|
499
499
|
* @public
|
|
500
500
|
* <p>Information about the cache location: </p>
|
|
501
|
-
*
|
|
501
|
+
* <ul>
|
|
502
502
|
* <li>
|
|
503
|
-
*
|
|
503
|
+
* <p>
|
|
504
504
|
* <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</p>
|
|
505
505
|
* </li>
|
|
506
506
|
* <li>
|
|
507
|
-
*
|
|
507
|
+
* <p>
|
|
508
508
|
* <code>S3</code>: This is the S3 bucket name/prefix.</p>
|
|
509
509
|
* </li>
|
|
510
510
|
* </ul>
|
|
@@ -515,60 +515,60 @@ export interface ProjectCache {
|
|
|
515
515
|
* <p>An array of strings that specify the local cache modes. You can use one or more local
|
|
516
516
|
* cache modes at the same time. This is only used for <code>LOCAL</code> cache
|
|
517
517
|
* types.</p>
|
|
518
|
-
*
|
|
519
|
-
*
|
|
518
|
+
* <p>Possible values are:</p>
|
|
519
|
+
* <dl>
|
|
520
520
|
* <dt>LOCAL_SOURCE_CACHE</dt>
|
|
521
521
|
* <dd>
|
|
522
|
-
*
|
|
522
|
+
* <p>Caches Git metadata for primary and secondary sources. After the cache is
|
|
523
523
|
* created, subsequent builds pull only the change between commits. This mode
|
|
524
524
|
* is a good choice for projects with a clean working directory and a source
|
|
525
525
|
* that is a large Git repository. If you choose this option and your project
|
|
526
526
|
* does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the
|
|
527
527
|
* option is ignored. </p>
|
|
528
|
-
*
|
|
528
|
+
* </dd>
|
|
529
529
|
* <dt>LOCAL_DOCKER_LAYER_CACHE</dt>
|
|
530
530
|
* <dd>
|
|
531
|
-
*
|
|
531
|
+
* <p>Caches existing Docker layers. This mode is a good choice for projects
|
|
532
532
|
* that build or pull large Docker images. It can prevent the performance
|
|
533
533
|
* issues caused by pulling large Docker images down from the network. </p>
|
|
534
|
-
*
|
|
535
|
-
*
|
|
534
|
+
* <note>
|
|
535
|
+
* <ul>
|
|
536
536
|
* <li>
|
|
537
|
-
*
|
|
537
|
+
* <p>You can use a Docker layer cache in the Linux environment
|
|
538
538
|
* only. </p>
|
|
539
|
-
*
|
|
539
|
+
* </li>
|
|
540
540
|
* <li>
|
|
541
|
-
*
|
|
541
|
+
* <p>The <code>privileged</code> flag must be set so that your
|
|
542
542
|
* project has the required Docker permissions. </p>
|
|
543
|
-
*
|
|
543
|
+
* </li>
|
|
544
544
|
* <li>
|
|
545
|
-
*
|
|
545
|
+
* <p>You should consider the security implications before you use a
|
|
546
546
|
* Docker layer cache. </p>
|
|
547
|
-
*
|
|
547
|
+
* </li>
|
|
548
548
|
* </ul>
|
|
549
|
-
*
|
|
550
|
-
*
|
|
549
|
+
* </note>
|
|
550
|
+
* </dd>
|
|
551
551
|
* <dt>LOCAL_CUSTOM_CACHE</dt>
|
|
552
552
|
* <dd>
|
|
553
|
-
*
|
|
553
|
+
* <p>Caches directories you specify in the buildspec file. This mode is a good
|
|
554
554
|
* choice if your build scenario is not suited to one of the other three local
|
|
555
555
|
* cache modes. If you use a custom cache: </p>
|
|
556
|
-
*
|
|
556
|
+
* <ul>
|
|
557
557
|
* <li>
|
|
558
|
-
*
|
|
558
|
+
* <p>Only directories can be specified for caching. You cannot specify
|
|
559
559
|
* individual files. </p>
|
|
560
|
-
*
|
|
560
|
+
* </li>
|
|
561
561
|
* <li>
|
|
562
|
-
*
|
|
563
|
-
*
|
|
562
|
+
* <p>Symlinks are used to reference cached directories. </p>
|
|
563
|
+
* </li>
|
|
564
564
|
* <li>
|
|
565
|
-
*
|
|
565
|
+
* <p>Cached directories are linked to your build before it downloads
|
|
566
566
|
* its project sources. Cached items are overridden if a source item
|
|
567
567
|
* has the same name. Directories are specified using cache paths in
|
|
568
568
|
* the buildspec file. </p>
|
|
569
|
-
*
|
|
569
|
+
* </li>
|
|
570
570
|
* </ul>
|
|
571
|
-
*
|
|
571
|
+
* </dd>
|
|
572
572
|
* </dl>
|
|
573
573
|
*/
|
|
574
574
|
modes?: (CacheMode | string)[];
|
|
@@ -613,34 +613,34 @@ export interface EnvironmentVariable {
|
|
|
613
613
|
/**
|
|
614
614
|
* @public
|
|
615
615
|
* <p>The value of the environment variable.</p>
|
|
616
|
-
*
|
|
616
|
+
* <important>
|
|
617
617
|
* <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to
|
|
618
618
|
* store sensitive values, especially Amazon Web Services secret key IDs and secret access keys.
|
|
619
619
|
* <code>PLAINTEXT</code> environment variables can be displayed in plain text
|
|
620
620
|
* using the CodeBuild console and the CLI. For sensitive values, we recommend you use an
|
|
621
621
|
* environment variable of type <code>PARAMETER_STORE</code> or
|
|
622
622
|
* <code>SECRETS_MANAGER</code>. </p>
|
|
623
|
-
*
|
|
623
|
+
* </important>
|
|
624
624
|
*/
|
|
625
625
|
value: string | undefined;
|
|
626
626
|
/**
|
|
627
627
|
* @public
|
|
628
628
|
* <p>The type of environment variable. Valid values include:</p>
|
|
629
|
-
*
|
|
629
|
+
* <ul>
|
|
630
630
|
* <li>
|
|
631
|
-
*
|
|
631
|
+
* <p>
|
|
632
632
|
* <code>PARAMETER_STORE</code>: An environment variable stored in Systems Manager
|
|
633
633
|
* Parameter Store. To learn how to specify a parameter store environment variable,
|
|
634
634
|
* see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store">env/parameter-store</a> in the
|
|
635
635
|
* <i>CodeBuild User Guide</i>.</p>
|
|
636
636
|
* </li>
|
|
637
637
|
* <li>
|
|
638
|
-
*
|
|
638
|
+
* <p>
|
|
639
639
|
* <code>PLAINTEXT</code>: An environment variable in plain text format. This is
|
|
640
640
|
* the default value.</p>
|
|
641
641
|
* </li>
|
|
642
642
|
* <li>
|
|
643
|
-
*
|
|
643
|
+
* <p>
|
|
644
644
|
* <code>SECRETS_MANAGER</code>: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see
|
|
645
645
|
* <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager">env/secrets-manager</a> in the
|
|
646
646
|
* <i>CodeBuild User Guide</i>.</p>
|
|
@@ -676,27 +676,27 @@ export type CredentialProviderType = (typeof CredentialProviderType)[keyof typeo
|
|
|
676
676
|
* @public
|
|
677
677
|
* <p> Information about credentials that provide access to a private Docker registry. When
|
|
678
678
|
* this is set: </p>
|
|
679
|
-
*
|
|
679
|
+
* <ul>
|
|
680
680
|
* <li>
|
|
681
|
-
*
|
|
682
|
-
*
|
|
681
|
+
* <p>
|
|
682
|
+
* <code>imagePullCredentialsType</code> must be set to <code>SERVICE_ROLE</code>.
|
|
683
683
|
* </p>
|
|
684
684
|
* </li>
|
|
685
685
|
* <li>
|
|
686
|
-
*
|
|
686
|
+
* <p> images cannot be curated or an Amazon ECR image.</p>
|
|
687
687
|
* </li>
|
|
688
688
|
* </ul>
|
|
689
|
-
*
|
|
689
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html">Private Registry with
|
|
690
690
|
* Secrets Manager Sample for CodeBuild</a>. </p>
|
|
691
691
|
*/
|
|
692
692
|
export interface RegistryCredential {
|
|
693
693
|
/**
|
|
694
694
|
* @public
|
|
695
695
|
* <p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p>
|
|
696
|
-
*
|
|
696
|
+
* <note>
|
|
697
697
|
* <p> The <code>credential</code> can use the name of the credentials only if they
|
|
698
698
|
* exist in your current Amazon Web Services Region. </p>
|
|
699
|
-
*
|
|
699
|
+
* </note>
|
|
700
700
|
*/
|
|
701
701
|
credential: string | undefined;
|
|
702
702
|
/**
|
|
@@ -729,15 +729,15 @@ export interface ProjectEnvironment {
|
|
|
729
729
|
/**
|
|
730
730
|
* @public
|
|
731
731
|
* <p>The type of build environment to use for related builds.</p>
|
|
732
|
-
*
|
|
732
|
+
* <ul>
|
|
733
733
|
* <li>
|
|
734
|
-
*
|
|
734
|
+
* <p>The environment type <code>ARM_CONTAINER</code> is available only in regions
|
|
735
735
|
* US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland),
|
|
736
736
|
* Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and
|
|
737
737
|
* EU (Frankfurt).</p>
|
|
738
738
|
* </li>
|
|
739
739
|
* <li>
|
|
740
|
-
*
|
|
740
|
+
* <p>The environment type <code>LINUX_CONTAINER</code> with compute type
|
|
741
741
|
* <code>build.general1.2xlarge</code> is available only in regions
|
|
742
742
|
* US East (N. Virginia), US East (Ohio), US West (Oregon),
|
|
743
743
|
* Canada (Central), EU (Ireland), EU (London),
|
|
@@ -746,7 +746,7 @@ export interface ProjectEnvironment {
|
|
|
746
746
|
* China (Ningxia).</p>
|
|
747
747
|
* </li>
|
|
748
748
|
* <li>
|
|
749
|
-
*
|
|
749
|
+
* <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in
|
|
750
750
|
* regions US East (N. Virginia), US East (Ohio), US West (Oregon),
|
|
751
751
|
* Canada (Central), EU (Ireland), EU (London),
|
|
752
752
|
* EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),
|
|
@@ -754,15 +754,15 @@ export interface ProjectEnvironment {
|
|
|
754
754
|
* China (Ningxia).</p>
|
|
755
755
|
* </li>
|
|
756
756
|
* </ul>
|
|
757
|
-
*
|
|
757
|
+
* <ul>
|
|
758
758
|
* <li>
|
|
759
|
-
*
|
|
759
|
+
* <p>The environment types <code>WINDOWS_CONTAINER</code> and
|
|
760
760
|
* <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions
|
|
761
761
|
* US East (N. Virginia), US East (Ohio), US West (Oregon), and
|
|
762
762
|
* EU (Ireland).</p>
|
|
763
763
|
* </li>
|
|
764
764
|
* </ul>
|
|
765
|
-
*
|
|
765
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build environment compute types</a> in the <i>CodeBuild
|
|
766
766
|
* user guide</i>.</p>
|
|
767
767
|
*/
|
|
768
768
|
type: EnvironmentType | string | undefined;
|
|
@@ -770,20 +770,20 @@ export interface ProjectEnvironment {
|
|
|
770
770
|
* @public
|
|
771
771
|
* <p>The image tag or image digest that identifies the Docker image to use for this build
|
|
772
772
|
* project. Use the following formats:</p>
|
|
773
|
-
*
|
|
773
|
+
* <ul>
|
|
774
774
|
* <li>
|
|
775
|
-
*
|
|
775
|
+
* <p>For an image tag: <code><registry>/<repository>:<tag></code>. For
|
|
776
776
|
* example, in the Docker repository that CodeBuild uses to manage its Docker
|
|
777
777
|
* images, this would be <code>aws/codebuild/standard:4.0</code>. </p>
|
|
778
778
|
* </li>
|
|
779
779
|
* <li>
|
|
780
|
-
*
|
|
780
|
+
* <p>For an image digest: <code><registry>/<repository>@<digest></code>.
|
|
781
781
|
* For example, to specify an image with the digest
|
|
782
782
|
* "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
|
|
783
783
|
* <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p>
|
|
784
784
|
* </li>
|
|
785
785
|
* </ul>
|
|
786
|
-
*
|
|
786
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html">Docker images provided by CodeBuild</a> in the <i>CodeBuild user
|
|
787
787
|
* guide</i>.</p>
|
|
788
788
|
*/
|
|
789
789
|
image: string | undefined;
|
|
@@ -791,47 +791,47 @@ export interface ProjectEnvironment {
|
|
|
791
791
|
* @public
|
|
792
792
|
* <p>Information about the compute resources the build project uses. Available values
|
|
793
793
|
* include:</p>
|
|
794
|
-
*
|
|
794
|
+
* <ul>
|
|
795
795
|
* <li>
|
|
796
|
-
*
|
|
796
|
+
* <p>
|
|
797
797
|
* <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for
|
|
798
798
|
* builds.</p>
|
|
799
799
|
* </li>
|
|
800
800
|
* <li>
|
|
801
|
-
*
|
|
801
|
+
* <p>
|
|
802
802
|
* <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for
|
|
803
803
|
* builds.</p>
|
|
804
804
|
* </li>
|
|
805
805
|
* <li>
|
|
806
|
-
*
|
|
806
|
+
* <p>
|
|
807
807
|
* <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for
|
|
808
808
|
* builds, depending on your environment type.</p>
|
|
809
809
|
* </li>
|
|
810
810
|
* <li>
|
|
811
|
-
*
|
|
811
|
+
* <p>
|
|
812
812
|
* <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and
|
|
813
813
|
* 824 GB of SSD storage for builds. This compute type supports Docker images up to
|
|
814
814
|
* 100 GB uncompressed.</p>
|
|
815
815
|
* </li>
|
|
816
816
|
* </ul>
|
|
817
|
-
*
|
|
818
|
-
*
|
|
817
|
+
* <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p>
|
|
818
|
+
* <ul>
|
|
819
819
|
* <li>
|
|
820
|
-
*
|
|
820
|
+
* <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB
|
|
821
821
|
* memory and 8 vCPUs for builds. </p>
|
|
822
822
|
* </li>
|
|
823
823
|
* <li>
|
|
824
|
-
*
|
|
824
|
+
* <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255
|
|
825
825
|
* GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p>
|
|
826
826
|
* </li>
|
|
827
827
|
* <li>
|
|
828
|
-
*
|
|
828
|
+
* <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB
|
|
829
829
|
* memory and 8 vCPUs on ARM-based processors for builds.</p>
|
|
830
830
|
* </li>
|
|
831
831
|
* </ul>
|
|
832
|
-
*
|
|
832
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment
|
|
833
833
|
* Compute Types</a> in the <i>CodeBuild User Guide.</i>
|
|
834
|
-
*
|
|
834
|
+
* </p>
|
|
835
835
|
*/
|
|
836
836
|
computeType: ComputeType | string | undefined;
|
|
837
837
|
/**
|
|
@@ -845,24 +845,24 @@ export interface ProjectEnvironment {
|
|
|
845
845
|
* <p>Enables running the Docker daemon inside a Docker container. Set to true only if the
|
|
846
846
|
* build project is used to build Docker images. Otherwise, a build that attempts to
|
|
847
847
|
* interact with the Docker daemon fails. The default setting is <code>false</code>.</p>
|
|
848
|
-
*
|
|
848
|
+
* <p>You can initialize the Docker daemon during the install phase of your build by adding
|
|
849
849
|
* one of the following sets of commands to the install phase of your buildspec
|
|
850
850
|
* file:</p>
|
|
851
|
-
*
|
|
852
|
-
*
|
|
851
|
+
* <p>If the operating system's base image is Ubuntu Linux:</p>
|
|
852
|
+
* <p>
|
|
853
853
|
* <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code>
|
|
854
|
-
*
|
|
855
|
-
*
|
|
854
|
+
* </p>
|
|
855
|
+
* <p>
|
|
856
856
|
* <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code>
|
|
857
|
-
*
|
|
858
|
-
*
|
|
857
|
+
* </p>
|
|
858
|
+
* <p>If the operating system's base image is Alpine Linux and the previous command does not
|
|
859
859
|
* work, add the <code>-t</code> argument to <code>timeout</code>:</p>
|
|
860
|
-
*
|
|
860
|
+
* <p>
|
|
861
861
|
* <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code>
|
|
862
862
|
* </p>
|
|
863
|
-
*
|
|
863
|
+
* <p>
|
|
864
864
|
* <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code>
|
|
865
|
-
*
|
|
865
|
+
* </p>
|
|
866
866
|
*/
|
|
867
867
|
privilegedMode?: boolean;
|
|
868
868
|
/**
|
|
@@ -881,19 +881,19 @@ export interface ProjectEnvironment {
|
|
|
881
881
|
* @public
|
|
882
882
|
* <p> The type of credentials CodeBuild uses to pull images in your build. There are two valid
|
|
883
883
|
* values: </p>
|
|
884
|
-
*
|
|
884
|
+
* <ul>
|
|
885
885
|
* <li>
|
|
886
|
-
*
|
|
887
|
-
*
|
|
886
|
+
* <p>
|
|
887
|
+
* <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials.
|
|
888
888
|
* This requires that you modify your ECR repository policy to trust CodeBuild service principal. </p>
|
|
889
889
|
* </li>
|
|
890
890
|
* <li>
|
|
891
|
-
*
|
|
892
|
-
*
|
|
891
|
+
* <p>
|
|
892
|
+
* <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service
|
|
893
893
|
* role. </p>
|
|
894
894
|
* </li>
|
|
895
895
|
* </ul>
|
|
896
|
-
*
|
|
896
|
+
* <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE
|
|
897
897
|
* credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
|
|
898
898
|
* </p>
|
|
899
899
|
*/
|
|
@@ -915,7 +915,7 @@ export type FileSystemType = (typeof FileSystemType)[keyof typeof FileSystemType
|
|
|
915
915
|
* <p> Information about a file system created by Amazon Elastic File System (EFS). For more
|
|
916
916
|
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">What Is
|
|
917
917
|
* Amazon Elastic File System?</a>
|
|
918
|
-
*
|
|
918
|
+
* </p>
|
|
919
919
|
*/
|
|
920
920
|
export interface ProjectFileSystemLocation {
|
|
921
921
|
/**
|
|
@@ -932,7 +932,7 @@ export interface ProjectFileSystemLocation {
|
|
|
932
932
|
* file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount
|
|
933
933
|
* directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is
|
|
934
934
|
* <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p>
|
|
935
|
-
*
|
|
935
|
+
* <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is
|
|
936
936
|
* optional. If you do not specify a directory path, the location is only the DNS name and
|
|
937
937
|
* CodeBuild mounts the entire file system. </p>
|
|
938
938
|
*/
|
|
@@ -949,7 +949,7 @@ export interface ProjectFileSystemLocation {
|
|
|
949
949
|
* <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for
|
|
950
950
|
* <code>identifier</code>, a new environment variable is create named
|
|
951
951
|
* <code>CODEBUILD_MY_EFS</code>. </p>
|
|
952
|
-
*
|
|
952
|
+
* <p> The <code>identifier</code> is used to mount your file system. </p>
|
|
953
953
|
*/
|
|
954
954
|
identifier?: string;
|
|
955
955
|
/**
|
|
@@ -982,13 +982,13 @@ export interface CloudWatchLogsConfig {
|
|
|
982
982
|
/**
|
|
983
983
|
* @public
|
|
984
984
|
* <p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p>
|
|
985
|
-
*
|
|
985
|
+
* <ul>
|
|
986
986
|
* <li>
|
|
987
|
-
*
|
|
987
|
+
* <p>
|
|
988
988
|
* <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p>
|
|
989
989
|
* </li>
|
|
990
990
|
* <li>
|
|
991
|
-
*
|
|
991
|
+
* <p>
|
|
992
992
|
* <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p>
|
|
993
993
|
* </li>
|
|
994
994
|
* </ul>
|
|
@@ -1015,13 +1015,13 @@ export interface S3LogsConfig {
|
|
|
1015
1015
|
/**
|
|
1016
1016
|
* @public
|
|
1017
1017
|
* <p>The current status of the S3 build logs. Valid values are:</p>
|
|
1018
|
-
*
|
|
1018
|
+
* <ul>
|
|
1019
1019
|
* <li>
|
|
1020
|
-
*
|
|
1020
|
+
* <p>
|
|
1021
1021
|
* <code>ENABLED</code>: S3 build logs are enabled for this build project.</p>
|
|
1022
1022
|
* </li>
|
|
1023
1023
|
* <li>
|
|
1024
|
-
*
|
|
1024
|
+
* <p>
|
|
1025
1025
|
* <code>DISABLED</code>: S3 build logs are not enabled for this build
|
|
1026
1026
|
* project.</p>
|
|
1027
1027
|
* </li>
|
|
@@ -1048,40 +1048,40 @@ export interface S3LogsConfig {
|
|
|
1048
1048
|
* Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
|
|
1049
1049
|
* access to these objects. This property allows you to give the bucket owner access to
|
|
1050
1050
|
* these objects.</p>
|
|
1051
|
-
*
|
|
1051
|
+
* <note>
|
|
1052
1052
|
* <p>To use this property, your CodeBuild service role must have the
|
|
1053
1053
|
* <code>s3:PutBucketAcl</code> permission. This permission allows CodeBuild to modify
|
|
1054
1054
|
* the access control list for the bucket.</p>
|
|
1055
|
-
*
|
|
1056
|
-
*
|
|
1055
|
+
* </note>
|
|
1056
|
+
* <p>This property can be one of the following values:</p>
|
|
1057
1057
|
* <dl>
|
|
1058
1058
|
* <dt>NONE</dt>
|
|
1059
1059
|
* <dd>
|
|
1060
|
-
*
|
|
1060
|
+
* <p>The bucket owner does not have access to the objects. This is the
|
|
1061
1061
|
* default.</p>
|
|
1062
1062
|
* </dd>
|
|
1063
1063
|
* <dt>READ_ONLY</dt>
|
|
1064
1064
|
* <dd>
|
|
1065
|
-
*
|
|
1065
|
+
* <p>The bucket owner has read-only access to the objects. The uploading account
|
|
1066
1066
|
* retains ownership of the objects.</p>
|
|
1067
1067
|
* </dd>
|
|
1068
1068
|
* <dt>FULL</dt>
|
|
1069
1069
|
* <dd>
|
|
1070
|
-
*
|
|
1070
|
+
* <p>The bucket owner has full access to the objects. Object ownership is determined
|
|
1071
1071
|
* by the following criteria:</p>
|
|
1072
|
-
*
|
|
1072
|
+
* <ul>
|
|
1073
1073
|
* <li>
|
|
1074
|
-
*
|
|
1074
|
+
* <p>If the bucket is configured with the <b>Bucket
|
|
1075
1075
|
* owner preferred</b> setting, the bucket owner owns the
|
|
1076
1076
|
* objects. The uploading account will have object access as specified
|
|
1077
1077
|
* by the bucket's policy.</p>
|
|
1078
|
-
*
|
|
1078
|
+
* </li>
|
|
1079
1079
|
* <li>
|
|
1080
|
-
*
|
|
1080
|
+
* <p>Otherwise, the uploading account retains ownership of the
|
|
1081
1081
|
* objects.</p>
|
|
1082
|
-
*
|
|
1082
|
+
* </li>
|
|
1083
1083
|
* </ul>
|
|
1084
|
-
*
|
|
1084
|
+
* <p>For more information about Amazon S3 object ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of uploaded objects using S3
|
|
1085
1085
|
* Object Ownership</a> in the <i>Amazon Simple Storage Service User
|
|
1086
1086
|
* Guide</i>.</p>
|
|
1087
1087
|
* </dd>
|
|
@@ -1150,67 +1150,67 @@ export interface BuildBatchPhase {
|
|
|
1150
1150
|
/**
|
|
1151
1151
|
* @public
|
|
1152
1152
|
* <p>The name of the batch build phase. Valid values include:</p>
|
|
1153
|
-
*
|
|
1153
|
+
* <dl>
|
|
1154
1154
|
* <dt>COMBINE_ARTIFACTS</dt>
|
|
1155
1155
|
* <dd>
|
|
1156
|
-
*
|
|
1156
|
+
* <p>Build output artifacts are being combined and uploaded to the output
|
|
1157
1157
|
* location.</p>
|
|
1158
|
-
*
|
|
1158
|
+
* </dd>
|
|
1159
1159
|
* <dt>DOWNLOAD_BATCHSPEC</dt>
|
|
1160
1160
|
* <dd>
|
|
1161
|
-
*
|
|
1162
|
-
*
|
|
1161
|
+
* <p>The batch build specification is being downloaded.</p>
|
|
1162
|
+
* </dd>
|
|
1163
1163
|
* <dt>FAILED</dt>
|
|
1164
1164
|
* <dd>
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1165
|
+
* <p>One or more of the builds failed.</p>
|
|
1166
|
+
* </dd>
|
|
1167
1167
|
* <dt>IN_PROGRESS</dt>
|
|
1168
1168
|
* <dd>
|
|
1169
|
-
*
|
|
1170
|
-
*
|
|
1169
|
+
* <p>The batch build is in progress.</p>
|
|
1170
|
+
* </dd>
|
|
1171
1171
|
* <dt>STOPPED</dt>
|
|
1172
1172
|
* <dd>
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
1173
|
+
* <p>The batch build was stopped.</p>
|
|
1174
|
+
* </dd>
|
|
1175
1175
|
* <dt>SUBMITTED</dt>
|
|
1176
1176
|
* <dd>
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1177
|
+
* <p>The btach build has been submitted.</p>
|
|
1178
|
+
* </dd>
|
|
1179
1179
|
* <dt>SUCCEEDED</dt>
|
|
1180
1180
|
* <dd>
|
|
1181
|
-
*
|
|
1182
|
-
*
|
|
1181
|
+
* <p>The batch build succeeded.</p>
|
|
1182
|
+
* </dd>
|
|
1183
1183
|
* </dl>
|
|
1184
1184
|
*/
|
|
1185
1185
|
phaseType?: BuildBatchPhaseType | string;
|
|
1186
1186
|
/**
|
|
1187
1187
|
* @public
|
|
1188
1188
|
* <p>The current status of the batch build phase. Valid values include:</p>
|
|
1189
|
-
*
|
|
1189
|
+
* <dl>
|
|
1190
1190
|
* <dt>FAILED</dt>
|
|
1191
1191
|
* <dd>
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1192
|
+
* <p>The build phase failed.</p>
|
|
1193
|
+
* </dd>
|
|
1194
1194
|
* <dt>FAULT</dt>
|
|
1195
1195
|
* <dd>
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1196
|
+
* <p>The build phase faulted.</p>
|
|
1197
|
+
* </dd>
|
|
1198
1198
|
* <dt>IN_PROGRESS</dt>
|
|
1199
1199
|
* <dd>
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1200
|
+
* <p>The build phase is still in progress.</p>
|
|
1201
|
+
* </dd>
|
|
1202
1202
|
* <dt>STOPPED</dt>
|
|
1203
1203
|
* <dd>
|
|
1204
|
-
*
|
|
1205
|
-
*
|
|
1204
|
+
* <p>The build phase stopped.</p>
|
|
1205
|
+
* </dd>
|
|
1206
1206
|
* <dt>SUCCEEDED</dt>
|
|
1207
1207
|
* <dd>
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1208
|
+
* <p>The build phase succeeded.</p>
|
|
1209
|
+
* </dd>
|
|
1210
1210
|
* <dt>TIMED_OUT</dt>
|
|
1211
1211
|
* <dd>
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
1212
|
+
* <p>The build phase timed out.</p>
|
|
1213
|
+
* </dd>
|
|
1214
1214
|
* </dl>
|
|
1215
1215
|
*/
|
|
1216
1216
|
phaseStatus?: StatusType | string;
|
|
@@ -1252,7 +1252,7 @@ export type SourceAuthType = (typeof SourceAuthType)[keyof typeof SourceAuthType
|
|
|
1252
1252
|
* @public
|
|
1253
1253
|
* <p>Information about the authorization settings for CodeBuild to access the source code to be
|
|
1254
1254
|
* built.</p>
|
|
1255
|
-
*
|
|
1255
|
+
* <p>This information is for the CodeBuild console's use only. Your code should not get or set
|
|
1256
1256
|
* this information directly.</p>
|
|
1257
1257
|
*/
|
|
1258
1258
|
export interface SourceAuth {
|
|
@@ -1260,8 +1260,8 @@ export interface SourceAuth {
|
|
|
1260
1260
|
* @public
|
|
1261
1261
|
* <note>
|
|
1262
1262
|
* <p> This data type is deprecated and is no longer accurate or used. </p>
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1263
|
+
* </note>
|
|
1264
|
+
* <p>The authorization type to use. The only valid value is <code>OAUTH</code>, which
|
|
1265
1265
|
* represents the OAuth authorization type.</p>
|
|
1266
1266
|
*/
|
|
1267
1267
|
type: SourceAuthType | string | undefined;
|
|
@@ -1281,17 +1281,17 @@ export interface BuildStatusConfig {
|
|
|
1281
1281
|
* @public
|
|
1282
1282
|
* <p>Specifies the context of the build status CodeBuild sends to the source provider. The
|
|
1283
1283
|
* usage of this parameter depends on the source provider.</p>
|
|
1284
|
-
*
|
|
1284
|
+
* <dl>
|
|
1285
1285
|
* <dt>Bitbucket</dt>
|
|
1286
1286
|
* <dd>
|
|
1287
|
-
*
|
|
1287
|
+
* <p>This parameter is used for the <code>name</code> parameter in the
|
|
1288
1288
|
* Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</p>
|
|
1289
|
-
*
|
|
1289
|
+
* </dd>
|
|
1290
1290
|
* <dt>GitHub/GitHub Enterprise Server</dt>
|
|
1291
1291
|
* <dd>
|
|
1292
|
-
*
|
|
1292
|
+
* <p>This parameter is used for the <code>context</code> parameter in the
|
|
1293
1293
|
* GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</p>
|
|
1294
|
-
*
|
|
1294
|
+
* </dd>
|
|
1295
1295
|
* </dl>
|
|
1296
1296
|
*/
|
|
1297
1297
|
context?: string;
|
|
@@ -1299,17 +1299,17 @@ export interface BuildStatusConfig {
|
|
|
1299
1299
|
* @public
|
|
1300
1300
|
* <p>Specifies the target url of the build status CodeBuild sends to the source provider. The
|
|
1301
1301
|
* usage of this parameter depends on the source provider.</p>
|
|
1302
|
-
*
|
|
1302
|
+
* <dl>
|
|
1303
1303
|
* <dt>Bitbucket</dt>
|
|
1304
1304
|
* <dd>
|
|
1305
|
-
*
|
|
1305
|
+
* <p>This parameter is used for the <code>url</code> parameter in the Bitbucket
|
|
1306
1306
|
* commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</p>
|
|
1307
|
-
*
|
|
1307
|
+
* </dd>
|
|
1308
1308
|
* <dt>GitHub/GitHub Enterprise Server</dt>
|
|
1309
1309
|
* <dd>
|
|
1310
|
-
*
|
|
1310
|
+
* <p>This parameter is used for the <code>target_url</code> parameter in the
|
|
1311
1311
|
* GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</p>
|
|
1312
|
-
*
|
|
1312
|
+
* </dd>
|
|
1313
1313
|
* </dl>
|
|
1314
1314
|
*/
|
|
1315
1315
|
targetUrl?: string;
|
|
@@ -1352,36 +1352,36 @@ export interface ProjectSource {
|
|
|
1352
1352
|
* @public
|
|
1353
1353
|
* <p>The type of repository that contains the source code to be built. Valid values
|
|
1354
1354
|
* include:</p>
|
|
1355
|
-
*
|
|
1355
|
+
* <ul>
|
|
1356
1356
|
* <li>
|
|
1357
|
-
*
|
|
1357
|
+
* <p>
|
|
1358
1358
|
* <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p>
|
|
1359
1359
|
* </li>
|
|
1360
1360
|
* <li>
|
|
1361
|
-
*
|
|
1361
|
+
* <p>
|
|
1362
1362
|
* <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p>
|
|
1363
1363
|
* </li>
|
|
1364
1364
|
* <li>
|
|
1365
|
-
*
|
|
1365
|
+
* <p>
|
|
1366
1366
|
* <code>CODEPIPELINE</code>: The source code settings are specified in the
|
|
1367
1367
|
* source action of a pipeline in CodePipeline.</p>
|
|
1368
1368
|
* </li>
|
|
1369
1369
|
* <li>
|
|
1370
|
-
*
|
|
1370
|
+
* <p>
|
|
1371
1371
|
* <code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud
|
|
1372
1372
|
* repository.</p>
|
|
1373
1373
|
* </li>
|
|
1374
1374
|
* <li>
|
|
1375
|
-
*
|
|
1375
|
+
* <p>
|
|
1376
1376
|
* <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise
|
|
1377
1377
|
* Server repository.</p>
|
|
1378
1378
|
* </li>
|
|
1379
1379
|
* <li>
|
|
1380
|
-
*
|
|
1380
|
+
* <p>
|
|
1381
1381
|
* <code>NO_SOURCE</code>: The project does not have input source code.</p>
|
|
1382
1382
|
* </li>
|
|
1383
1383
|
* <li>
|
|
1384
|
-
*
|
|
1384
|
+
* <p>
|
|
1385
1385
|
* <code>S3</code>: The source code is in an Amazon S3 bucket.</p>
|
|
1386
1386
|
* </li>
|
|
1387
1387
|
* </ul>
|
|
@@ -1391,33 +1391,33 @@ export interface ProjectSource {
|
|
|
1391
1391
|
* @public
|
|
1392
1392
|
* <p>Information about the location of the source code to be built. Valid values
|
|
1393
1393
|
* include:</p>
|
|
1394
|
-
*
|
|
1394
|
+
* <ul>
|
|
1395
1395
|
* <li>
|
|
1396
|
-
*
|
|
1396
|
+
* <p>For source code settings that are specified in the source action of a pipeline
|
|
1397
1397
|
* in CodePipeline, <code>location</code> should not be specified. If it is specified,
|
|
1398
1398
|
* CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source
|
|
1399
1399
|
* action instead of this value.</p>
|
|
1400
1400
|
* </li>
|
|
1401
1401
|
* <li>
|
|
1402
|
-
*
|
|
1402
|
+
* <p>For source code in an CodeCommit repository, the HTTPS clone URL to the repository
|
|
1403
1403
|
* that contains the source code and the buildspec file (for example,
|
|
1404
1404
|
* <code>https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name></code>).</p>
|
|
1405
1405
|
* </li>
|
|
1406
1406
|
* <li>
|
|
1407
|
-
*
|
|
1408
|
-
*
|
|
1407
|
+
* <p>For source code in an Amazon S3 input bucket, one of the following. </p>
|
|
1408
|
+
* <ul>
|
|
1409
1409
|
* <li>
|
|
1410
|
-
*
|
|
1410
|
+
* <p>The path to the ZIP file that contains the source code (for example,
|
|
1411
1411
|
* <code><bucket-name>/<path>/<object-name>.zip</code>). </p>
|
|
1412
|
-
*
|
|
1412
|
+
* </li>
|
|
1413
1413
|
* <li>
|
|
1414
|
-
*
|
|
1414
|
+
* <p>The path to the folder that contains the source code (for example,
|
|
1415
1415
|
* <code><bucket-name>/<path-to-source-code>/<folder>/</code>). </p>
|
|
1416
|
-
*
|
|
1416
|
+
* </li>
|
|
1417
1417
|
* </ul>
|
|
1418
1418
|
* </li>
|
|
1419
1419
|
* <li>
|
|
1420
|
-
*
|
|
1420
|
+
* <p>For source code in a GitHub repository, the HTTPS clone URL to the repository
|
|
1421
1421
|
* that contains the source and the buildspec file. You must connect your Amazon Web Services account
|
|
1422
1422
|
* to your GitHub account. Use the CodeBuild console to start creating a build
|
|
1423
1423
|
* project. When you use the console to connect (or reconnect) with GitHub, on the
|
|
@@ -1431,7 +1431,7 @@ export interface ProjectSource {
|
|
|
1431
1431
|
* <code>OAUTH</code>.</p>
|
|
1432
1432
|
* </li>
|
|
1433
1433
|
* <li>
|
|
1434
|
-
*
|
|
1434
|
+
* <p>For source code in a Bitbucket repository, the HTTPS clone URL to the
|
|
1435
1435
|
* repository that contains the source and the buildspec file. You must connect
|
|
1436
1436
|
* your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start
|
|
1437
1437
|
* creating a build project. When you use the console to connect (or reconnect)
|
|
@@ -1444,7 +1444,7 @@ export interface ProjectSource {
|
|
|
1444
1444
|
* <code>OAUTH</code>.</p>
|
|
1445
1445
|
* </li>
|
|
1446
1446
|
* </ul>
|
|
1447
|
-
*
|
|
1447
|
+
* <p>
|
|
1448
1448
|
* If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this
|
|
1449
1449
|
* property. For all of the other types, you must specify <code>Location</code>.
|
|
1450
1450
|
* </p>
|
|
@@ -1463,7 +1463,7 @@ export interface ProjectSource {
|
|
|
1463
1463
|
/**
|
|
1464
1464
|
* @public
|
|
1465
1465
|
* <p>The buildspec file declaration to use for the builds in this build project.</p>
|
|
1466
|
-
*
|
|
1466
|
+
* <p> If this value is set, it can be either an inline buildspec definition, the path to an
|
|
1467
1467
|
* alternate buildspec file relative to the value of the built-in
|
|
1468
1468
|
* <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket.
|
|
1469
1469
|
* The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
|
|
@@ -1477,7 +1477,7 @@ export interface ProjectSource {
|
|
|
1477
1477
|
* @public
|
|
1478
1478
|
* <p>Information about the authorization settings for CodeBuild to access the source code to be
|
|
1479
1479
|
* built.</p>
|
|
1480
|
-
*
|
|
1480
|
+
* <p>This information is for the CodeBuild console's use only. Your code should not get or set
|
|
1481
1481
|
* this information directly.</p>
|
|
1482
1482
|
*/
|
|
1483
1483
|
auth?: SourceAuth;
|
|
@@ -1487,11 +1487,11 @@ export interface ProjectSource {
|
|
|
1487
1487
|
* provider. This option is valid only when your source provider is GitHub, GitHub
|
|
1488
1488
|
* Enterprise, or Bitbucket. If this is set and you use a different source provider, an
|
|
1489
1489
|
* <code>invalidInputException</code> is thrown. </p>
|
|
1490
|
-
*
|
|
1490
|
+
* <p>To be able to report the build status to the source provider, the user associated with the source provider must
|
|
1491
1491
|
* have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p>
|
|
1492
|
-
*
|
|
1492
|
+
* <p>The status of a build triggered by a webhook is always reported to your source
|
|
1493
1493
|
* provider. </p>
|
|
1494
|
-
*
|
|
1494
|
+
* <p>If your project's builds are triggered by a webhook, you must push a
|
|
1495
1495
|
* new commit to the repo for a change to this property to take
|
|
1496
1496
|
* effect.</p>
|
|
1497
1497
|
*/
|
|
@@ -1534,10 +1534,10 @@ export interface ProjectSourceVersion {
|
|
|
1534
1534
|
* of:</p>
|
|
1535
1535
|
* <ul>
|
|
1536
1536
|
* <li>
|
|
1537
|
-
*
|
|
1537
|
+
* <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p>
|
|
1538
1538
|
* </li>
|
|
1539
1539
|
* <li>
|
|
1540
|
-
*
|
|
1540
|
+
* <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that
|
|
1541
1541
|
* corresponds to the version of the source code you want to build. If a pull
|
|
1542
1542
|
* request ID is specified, it must use the format <code>pr/pull-request-ID</code>
|
|
1543
1543
|
* (for example, <code>pr/25</code>). If a branch name is specified, the branch's
|
|
@@ -1545,13 +1545,13 @@ export interface ProjectSourceVersion {
|
|
|
1545
1545
|
* used.</p>
|
|
1546
1546
|
* </li>
|
|
1547
1547
|
* <li>
|
|
1548
|
-
*
|
|
1548
|
+
* <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the
|
|
1549
1549
|
* version of the source code you want to build. If a branch name is specified, the
|
|
1550
1550
|
* branch's HEAD commit ID is used. If not specified, the default branch's HEAD
|
|
1551
1551
|
* commit ID is used.</p>
|
|
1552
1552
|
* </li>
|
|
1553
1553
|
* <li>
|
|
1554
|
-
*
|
|
1554
|
+
* <p>For Amazon S3: the version ID of the object that represents the build input ZIP
|
|
1555
1555
|
* file to use.</p>
|
|
1556
1556
|
* </li>
|
|
1557
1557
|
* </ul>
|
|
@@ -1624,15 +1624,15 @@ export interface BuildBatch {
|
|
|
1624
1624
|
/**
|
|
1625
1625
|
* @public
|
|
1626
1626
|
* <p>The identifier of the resolved version of this batch build's source code.</p>
|
|
1627
|
-
*
|
|
1627
|
+
* <ul>
|
|
1628
1628
|
* <li>
|
|
1629
|
-
*
|
|
1629
|
+
* <p>For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.</p>
|
|
1630
1630
|
* </li>
|
|
1631
1631
|
* <li>
|
|
1632
|
-
*
|
|
1632
|
+
* <p>For CodePipeline, the source revision provided by CodePipeline.</p>
|
|
1633
1633
|
* </li>
|
|
1634
1634
|
* <li>
|
|
1635
|
-
*
|
|
1635
|
+
* <p>For Amazon S3, this does not apply.</p>
|
|
1636
1636
|
* </li>
|
|
1637
1637
|
* </ul>
|
|
1638
1638
|
*/
|
|
@@ -1740,16 +1740,16 @@ export interface BuildBatch {
|
|
|
1740
1740
|
/**
|
|
1741
1741
|
* @public
|
|
1742
1742
|
* <p>The entity that started the batch build. Valid values include:</p>
|
|
1743
|
-
*
|
|
1743
|
+
* <ul>
|
|
1744
1744
|
* <li>
|
|
1745
|
-
*
|
|
1745
|
+
* <p>If CodePipeline started the build, the pipeline's name (for example,
|
|
1746
1746
|
* <code>codepipeline/my-demo-pipeline</code>).</p>
|
|
1747
1747
|
* </li>
|
|
1748
1748
|
* <li>
|
|
1749
|
-
*
|
|
1749
|
+
* <p>If an IAM user started the build, the user's name.</p>
|
|
1750
1750
|
* </li>
|
|
1751
1751
|
* <li>
|
|
1752
|
-
*
|
|
1752
|
+
* <p>If the Jenkins plugin for CodeBuild started the build, the string
|
|
1753
1753
|
* <code>CodeBuild-Jenkins-Plugin</code>.</p>
|
|
1754
1754
|
* </li>
|
|
1755
1755
|
* </ul>
|
|
@@ -1764,11 +1764,11 @@ export interface BuildBatch {
|
|
|
1764
1764
|
* @public
|
|
1765
1765
|
* <p>The Key Management Service customer master key (CMK) to be used for encrypting the batch build output
|
|
1766
1766
|
* artifacts.</p>
|
|
1767
|
-
*
|
|
1767
|
+
* <note>
|
|
1768
1768
|
* <p>You can use a cross-account KMS key to encrypt the build output artifacts if your
|
|
1769
1769
|
* service role has permission to that key. </p>
|
|
1770
|
-
*
|
|
1771
|
-
*
|
|
1770
|
+
* </note>
|
|
1771
|
+
* <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
|
|
1772
1772
|
* the format <code>alias/<alias-name></code>).</p>
|
|
1773
1773
|
*/
|
|
1774
1774
|
encryptionKey?: string;
|
|
@@ -1855,10 +1855,10 @@ export interface DebugSession {
|
|
|
1855
1855
|
/**
|
|
1856
1856
|
* @public
|
|
1857
1857
|
* <p>Contains information about an exported environment variable. </p>
|
|
1858
|
-
*
|
|
1858
|
+
* <p>Exported environment variables are used in conjunction with CodePipeline to export
|
|
1859
1859
|
* environment variables from the current build stage to subsequent stages in the pipeline.
|
|
1860
1860
|
* For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html">Working with variables</a> in the <i>CodePipeline User Guide</i>.</p>
|
|
1861
|
-
*
|
|
1861
|
+
* <note>
|
|
1862
1862
|
* <p> During a build, the value of a variable is available starting with the
|
|
1863
1863
|
* <code>install</code> phase. It can be updated between the start of the
|
|
1864
1864
|
* <code>install</code> phase and the end of the <code>post_build</code> phase.
|
|
@@ -1973,83 +1973,83 @@ export interface BuildPhase {
|
|
|
1973
1973
|
/**
|
|
1974
1974
|
* @public
|
|
1975
1975
|
* <p>The name of the build phase. Valid values include:</p>
|
|
1976
|
-
*
|
|
1976
|
+
* <dl>
|
|
1977
1977
|
* <dt>BUILD</dt>
|
|
1978
1978
|
* <dd>
|
|
1979
|
-
*
|
|
1980
|
-
*
|
|
1979
|
+
* <p>Core build activities typically occur in this build phase.</p>
|
|
1980
|
+
* </dd>
|
|
1981
1981
|
* <dt>COMPLETED</dt>
|
|
1982
1982
|
* <dd>
|
|
1983
|
-
*
|
|
1984
|
-
*
|
|
1983
|
+
* <p>The build has been completed.</p>
|
|
1984
|
+
* </dd>
|
|
1985
1985
|
* <dt>DOWNLOAD_SOURCE</dt>
|
|
1986
1986
|
* <dd>
|
|
1987
|
-
*
|
|
1988
|
-
*
|
|
1987
|
+
* <p>Source code is being downloaded in this build phase.</p>
|
|
1988
|
+
* </dd>
|
|
1989
1989
|
* <dt>FINALIZING</dt>
|
|
1990
1990
|
* <dd>
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
1991
|
+
* <p>The build process is completing in this build phase.</p>
|
|
1992
|
+
* </dd>
|
|
1993
1993
|
* <dt>INSTALL</dt>
|
|
1994
1994
|
* <dd>
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
1995
|
+
* <p>Installation activities typically occur in this build phase.</p>
|
|
1996
|
+
* </dd>
|
|
1997
1997
|
* <dt>POST_BUILD</dt>
|
|
1998
1998
|
* <dd>
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
1999
|
+
* <p>Post-build activities typically occur in this build phase.</p>
|
|
2000
|
+
* </dd>
|
|
2001
2001
|
* <dt>PRE_BUILD</dt>
|
|
2002
2002
|
* <dd>
|
|
2003
|
-
*
|
|
2004
|
-
*
|
|
2003
|
+
* <p>Pre-build activities typically occur in this build phase.</p>
|
|
2004
|
+
* </dd>
|
|
2005
2005
|
* <dt>PROVISIONING</dt>
|
|
2006
2006
|
* <dd>
|
|
2007
|
-
*
|
|
2008
|
-
*
|
|
2007
|
+
* <p>The build environment is being set up.</p>
|
|
2008
|
+
* </dd>
|
|
2009
2009
|
* <dt>QUEUED</dt>
|
|
2010
2010
|
* <dd>
|
|
2011
|
-
*
|
|
2011
|
+
* <p>The build has been submitted and is queued behind other submitted
|
|
2012
2012
|
* builds.</p>
|
|
2013
|
-
*
|
|
2013
|
+
* </dd>
|
|
2014
2014
|
* <dt>SUBMITTED</dt>
|
|
2015
2015
|
* <dd>
|
|
2016
|
-
*
|
|
2017
|
-
*
|
|
2016
|
+
* <p>The build has been submitted.</p>
|
|
2017
|
+
* </dd>
|
|
2018
2018
|
* <dt>UPLOAD_ARTIFACTS</dt>
|
|
2019
2019
|
* <dd>
|
|
2020
|
-
*
|
|
2021
|
-
*
|
|
2020
|
+
* <p>Build output artifacts are being uploaded to the output location.</p>
|
|
2021
|
+
* </dd>
|
|
2022
2022
|
* </dl>
|
|
2023
2023
|
*/
|
|
2024
2024
|
phaseType?: BuildPhaseType | string;
|
|
2025
2025
|
/**
|
|
2026
2026
|
* @public
|
|
2027
2027
|
* <p>The current status of the build phase. Valid values include:</p>
|
|
2028
|
-
*
|
|
2028
|
+
* <dl>
|
|
2029
2029
|
* <dt>FAILED</dt>
|
|
2030
2030
|
* <dd>
|
|
2031
|
-
*
|
|
2032
|
-
*
|
|
2031
|
+
* <p>The build phase failed.</p>
|
|
2032
|
+
* </dd>
|
|
2033
2033
|
* <dt>FAULT</dt>
|
|
2034
2034
|
* <dd>
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2035
|
+
* <p>The build phase faulted.</p>
|
|
2036
|
+
* </dd>
|
|
2037
2037
|
* <dt>IN_PROGRESS</dt>
|
|
2038
2038
|
* <dd>
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2039
|
+
* <p>The build phase is still in progress.</p>
|
|
2040
|
+
* </dd>
|
|
2041
2041
|
* <dt>STOPPED</dt>
|
|
2042
2042
|
* <dd>
|
|
2043
|
-
*
|
|
2044
|
-
*
|
|
2043
|
+
* <p>The build phase stopped.</p>
|
|
2044
|
+
* </dd>
|
|
2045
2045
|
* <dt>SUCCEEDED</dt>
|
|
2046
2046
|
* <dd>
|
|
2047
|
-
*
|
|
2048
|
-
*
|
|
2047
|
+
* <p>The build phase succeeded.</p>
|
|
2048
|
+
* </dd>
|
|
2049
2049
|
* <dt>TIMED_OUT</dt>
|
|
2050
2050
|
* <dd>
|
|
2051
|
-
*
|
|
2052
|
-
*
|
|
2051
|
+
* <p>The build phase timed out.</p>
|
|
2052
|
+
* </dd>
|
|
2053
2053
|
* </dl>
|
|
2054
2054
|
*/
|
|
2055
2055
|
phaseStatus?: StatusType | string;
|
|
@@ -2117,29 +2117,29 @@ export interface Build {
|
|
|
2117
2117
|
/**
|
|
2118
2118
|
* @public
|
|
2119
2119
|
* <p>The current status of the build. Valid values include:</p>
|
|
2120
|
-
*
|
|
2120
|
+
* <ul>
|
|
2121
2121
|
* <li>
|
|
2122
|
-
*
|
|
2122
|
+
* <p>
|
|
2123
2123
|
* <code>FAILED</code>: The build failed.</p>
|
|
2124
2124
|
* </li>
|
|
2125
2125
|
* <li>
|
|
2126
|
-
*
|
|
2126
|
+
* <p>
|
|
2127
2127
|
* <code>FAULT</code>: The build faulted.</p>
|
|
2128
2128
|
* </li>
|
|
2129
2129
|
* <li>
|
|
2130
|
-
*
|
|
2130
|
+
* <p>
|
|
2131
2131
|
* <code>IN_PROGRESS</code>: The build is still in progress.</p>
|
|
2132
2132
|
* </li>
|
|
2133
2133
|
* <li>
|
|
2134
|
-
*
|
|
2134
|
+
* <p>
|
|
2135
2135
|
* <code>STOPPED</code>: The build stopped.</p>
|
|
2136
2136
|
* </li>
|
|
2137
2137
|
* <li>
|
|
2138
|
-
*
|
|
2138
|
+
* <p>
|
|
2139
2139
|
* <code>SUCCEEDED</code>: The build succeeded.</p>
|
|
2140
2140
|
* </li>
|
|
2141
2141
|
* <li>
|
|
2142
|
-
*
|
|
2142
|
+
* <p>
|
|
2143
2143
|
* <code>TIMED_OUT</code>: The build timed out.</p>
|
|
2144
2144
|
* </li>
|
|
2145
2145
|
* </ul>
|
|
@@ -2150,22 +2150,22 @@ export interface Build {
|
|
|
2150
2150
|
* <p>Any version identifier for the version of the source code to be built. If
|
|
2151
2151
|
* <code>sourceVersion</code> is specified at the project level, then this
|
|
2152
2152
|
* <code>sourceVersion</code> (at the build level) takes precedence. </p>
|
|
2153
|
-
*
|
|
2153
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample
|
|
2154
2154
|
* with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
|
|
2155
2155
|
*/
|
|
2156
2156
|
sourceVersion?: string;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* @public
|
|
2159
2159
|
* <p> An identifier for the version of this build's source code. </p>
|
|
2160
|
-
*
|
|
2160
|
+
* <ul>
|
|
2161
2161
|
* <li>
|
|
2162
|
-
*
|
|
2162
|
+
* <p> For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. </p>
|
|
2163
2163
|
* </li>
|
|
2164
2164
|
* <li>
|
|
2165
|
-
*
|
|
2165
|
+
* <p> For CodePipeline, the source revision provided by CodePipeline. </p>
|
|
2166
2166
|
* </li>
|
|
2167
2167
|
* <li>
|
|
2168
|
-
*
|
|
2168
|
+
* <p> For Amazon S3, this does not apply. </p>
|
|
2169
2169
|
* </li>
|
|
2170
2170
|
* </ul>
|
|
2171
2171
|
*/
|
|
@@ -2195,12 +2195,12 @@ export interface Build {
|
|
|
2195
2195
|
* @public
|
|
2196
2196
|
* <p> An array of <code>ProjectSourceVersion</code> objects. Each
|
|
2197
2197
|
* <code>ProjectSourceVersion</code> must be one of: </p>
|
|
2198
|
-
*
|
|
2198
|
+
* <ul>
|
|
2199
2199
|
* <li>
|
|
2200
|
-
*
|
|
2200
|
+
* <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p>
|
|
2201
2201
|
* </li>
|
|
2202
2202
|
* <li>
|
|
2203
|
-
*
|
|
2203
|
+
* <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that
|
|
2204
2204
|
* corresponds to the version of the source code you want to build. If a pull
|
|
2205
2205
|
* request ID is specified, it must use the format <code>pr/pull-request-ID</code>
|
|
2206
2206
|
* (for example, <code>pr/25</code>). If a branch name is specified, the branch's
|
|
@@ -2208,13 +2208,13 @@ export interface Build {
|
|
|
2208
2208
|
* used.</p>
|
|
2209
2209
|
* </li>
|
|
2210
2210
|
* <li>
|
|
2211
|
-
*
|
|
2211
|
+
* <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the
|
|
2212
2212
|
* version of the source code you want to build. If a branch name is specified, the
|
|
2213
2213
|
* branch's HEAD commit ID is used. If not specified, the default branch's HEAD
|
|
2214
2214
|
* commit ID is used.</p>
|
|
2215
2215
|
* </li>
|
|
2216
2216
|
* <li>
|
|
2217
|
-
*
|
|
2217
|
+
* <p>For Amazon S3: the version ID of the object that represents the build input ZIP
|
|
2218
2218
|
* file to use.</p>
|
|
2219
2219
|
* </li>
|
|
2220
2220
|
* </ul>
|
|
@@ -2269,17 +2269,17 @@ export interface Build {
|
|
|
2269
2269
|
/**
|
|
2270
2270
|
* @public
|
|
2271
2271
|
* <p>The entity that started the build. Valid values include:</p>
|
|
2272
|
-
*
|
|
2272
|
+
* <ul>
|
|
2273
2273
|
* <li>
|
|
2274
|
-
*
|
|
2274
|
+
* <p>If CodePipeline started the build, the pipeline's name (for example,
|
|
2275
2275
|
* <code>codepipeline/my-demo-pipeline</code>).</p>
|
|
2276
2276
|
* </li>
|
|
2277
2277
|
* <li>
|
|
2278
|
-
*
|
|
2278
|
+
* <p>If an IAM user started the build, the user's name (for example,
|
|
2279
2279
|
* <code>MyUserName</code>).</p>
|
|
2280
2280
|
* </li>
|
|
2281
2281
|
* <li>
|
|
2282
|
-
*
|
|
2282
|
+
* <p>If the Jenkins plugin for CodeBuild started the build, the string
|
|
2283
2283
|
* <code>CodeBuild-Jenkins-Plugin</code>.</p>
|
|
2284
2284
|
* </li>
|
|
2285
2285
|
* </ul>
|
|
@@ -2302,18 +2302,18 @@ export interface Build {
|
|
|
2302
2302
|
* @public
|
|
2303
2303
|
* <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output
|
|
2304
2304
|
* artifacts.</p>
|
|
2305
|
-
*
|
|
2305
|
+
* <note>
|
|
2306
2306
|
* <p> You can use a cross-account KMS key to encrypt the build output artifacts if your
|
|
2307
2307
|
* service role has permission to that key. </p>
|
|
2308
|
-
*
|
|
2309
|
-
*
|
|
2308
|
+
* </note>
|
|
2309
|
+
* <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
|
|
2310
2310
|
* the format <code>alias/<alias-name></code>).</p>
|
|
2311
2311
|
*/
|
|
2312
2312
|
encryptionKey?: string;
|
|
2313
2313
|
/**
|
|
2314
2314
|
* @public
|
|
2315
2315
|
* <p>A list of exported environment variables for this build.</p>
|
|
2316
|
-
*
|
|
2316
|
+
* <p>Exported environment variables are used in conjunction with CodePipeline to export
|
|
2317
2317
|
* environment variables from the current build stage to subsequent stages in the pipeline.
|
|
2318
2318
|
* For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html">Working with variables</a> in the <i>CodePipeline User Guide</i>.</p>
|
|
2319
2319
|
*/
|
|
@@ -2378,23 +2378,23 @@ export interface ProjectArtifacts {
|
|
|
2378
2378
|
/**
|
|
2379
2379
|
* @public
|
|
2380
2380
|
* <p>The type of build output artifact. Valid values include:</p>
|
|
2381
|
-
*
|
|
2381
|
+
* <ul>
|
|
2382
2382
|
* <li>
|
|
2383
|
-
*
|
|
2383
|
+
* <p>
|
|
2384
2384
|
* <code>CODEPIPELINE</code>: The build project has build output generated
|
|
2385
2385
|
* through CodePipeline. </p>
|
|
2386
|
-
*
|
|
2387
|
-
*
|
|
2386
|
+
* <note>
|
|
2387
|
+
* <p>The <code>CODEPIPELINE</code> type is not supported for
|
|
2388
2388
|
* <code>secondaryArtifacts</code>.</p>
|
|
2389
|
-
*
|
|
2389
|
+
* </note>
|
|
2390
2390
|
* </li>
|
|
2391
2391
|
* <li>
|
|
2392
|
-
*
|
|
2392
|
+
* <p>
|
|
2393
2393
|
* <code>NO_ARTIFACTS</code>: The build project does not produce any build
|
|
2394
2394
|
* output.</p>
|
|
2395
2395
|
* </li>
|
|
2396
2396
|
* <li>
|
|
2397
|
-
*
|
|
2397
|
+
* <p>
|
|
2398
2398
|
* <code>S3</code>: The build project stores build output in Amazon S3.</p>
|
|
2399
2399
|
* </li>
|
|
2400
2400
|
* </ul>
|
|
@@ -2403,18 +2403,18 @@ export interface ProjectArtifacts {
|
|
|
2403
2403
|
/**
|
|
2404
2404
|
* @public
|
|
2405
2405
|
* <p>Information about the build output artifact location:</p>
|
|
2406
|
-
*
|
|
2406
|
+
* <ul>
|
|
2407
2407
|
* <li>
|
|
2408
|
-
*
|
|
2408
|
+
* <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this
|
|
2409
2409
|
* value if specified. This is because CodePipeline manages its build output locations
|
|
2410
2410
|
* instead of CodeBuild.</p>
|
|
2411
2411
|
* </li>
|
|
2412
2412
|
* <li>
|
|
2413
|
-
*
|
|
2413
|
+
* <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is
|
|
2414
2414
|
* ignored if specified, because no build output is produced.</p>
|
|
2415
2415
|
* </li>
|
|
2416
2416
|
* <li>
|
|
2417
|
-
*
|
|
2417
|
+
* <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output
|
|
2418
2418
|
* bucket.</p>
|
|
2419
2419
|
* </li>
|
|
2420
2420
|
* </ul>
|
|
@@ -2424,23 +2424,23 @@ export interface ProjectArtifacts {
|
|
|
2424
2424
|
* @public
|
|
2425
2425
|
* <p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild
|
|
2426
2426
|
* uses to name and store the output artifact:</p>
|
|
2427
|
-
*
|
|
2427
|
+
* <ul>
|
|
2428
2428
|
* <li>
|
|
2429
|
-
*
|
|
2429
|
+
* <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this
|
|
2430
2430
|
* value if specified. This is because CodePipeline manages its build output names instead
|
|
2431
2431
|
* of CodeBuild.</p>
|
|
2432
2432
|
* </li>
|
|
2433
2433
|
* <li>
|
|
2434
|
-
*
|
|
2434
|
+
* <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is
|
|
2435
2435
|
* ignored if specified, because no build output is produced.</p>
|
|
2436
2436
|
* </li>
|
|
2437
2437
|
* <li>
|
|
2438
|
-
*
|
|
2438
|
+
* <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output
|
|
2439
2439
|
* artifact. If <code>path</code> is not specified, <code>path</code> is not
|
|
2440
2440
|
* used.</p>
|
|
2441
2441
|
* </li>
|
|
2442
2442
|
* </ul>
|
|
2443
|
-
*
|
|
2443
|
+
* <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>,
|
|
2444
2444
|
* <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set
|
|
2445
2445
|
* to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at
|
|
2446
2446
|
* <code>MyArtifacts/MyArtifact.zip</code>.</p>
|
|
@@ -2450,33 +2450,33 @@ export interface ProjectArtifacts {
|
|
|
2450
2450
|
* @public
|
|
2451
2451
|
* <p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to
|
|
2452
2452
|
* determine the name and location to store the output artifact:</p>
|
|
2453
|
-
*
|
|
2453
|
+
* <ul>
|
|
2454
2454
|
* <li>
|
|
2455
|
-
*
|
|
2455
|
+
* <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this
|
|
2456
2456
|
* value if specified. This is because CodePipeline manages its build output names instead
|
|
2457
2457
|
* of CodeBuild.</p>
|
|
2458
2458
|
* </li>
|
|
2459
2459
|
* <li>
|
|
2460
|
-
*
|
|
2460
|
+
* <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is
|
|
2461
2461
|
* ignored if specified, because no build output is produced.</p>
|
|
2462
2462
|
* </li>
|
|
2463
2463
|
* <li>
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2464
|
+
* <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p>
|
|
2465
|
+
* <ul>
|
|
2466
2466
|
* <li>
|
|
2467
|
-
*
|
|
2467
|
+
* <p>
|
|
2468
2468
|
* <code>BUILD_ID</code>: Include the build ID in the location of the
|
|
2469
2469
|
* build output artifact.</p>
|
|
2470
|
-
*
|
|
2470
|
+
* </li>
|
|
2471
2471
|
* <li>
|
|
2472
|
-
*
|
|
2472
|
+
* <p>
|
|
2473
2473
|
* <code>NONE</code>: Do not include the build ID. This is the default if
|
|
2474
2474
|
* <code>namespaceType</code> is not specified.</p>
|
|
2475
|
-
*
|
|
2475
|
+
* </li>
|
|
2476
2476
|
* </ul>
|
|
2477
2477
|
* </li>
|
|
2478
2478
|
* </ul>
|
|
2479
|
-
*
|
|
2479
|
+
* <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>,
|
|
2480
2480
|
* <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is
|
|
2481
2481
|
* set to <code>MyArtifact.zip</code>, the output artifact is stored in
|
|
2482
2482
|
* <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>
|
|
@@ -2486,37 +2486,37 @@ export interface ProjectArtifacts {
|
|
|
2486
2486
|
* @public
|
|
2487
2487
|
* <p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild
|
|
2488
2488
|
* uses to name and store the output artifact:</p>
|
|
2489
|
-
*
|
|
2489
|
+
* <ul>
|
|
2490
2490
|
* <li>
|
|
2491
|
-
*
|
|
2491
|
+
* <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this
|
|
2492
2492
|
* value if specified. This is because CodePipeline manages its build output names instead
|
|
2493
2493
|
* of CodeBuild.</p>
|
|
2494
2494
|
* </li>
|
|
2495
2495
|
* <li>
|
|
2496
|
-
*
|
|
2496
|
+
* <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is
|
|
2497
2497
|
* ignored if specified, because no build output is produced.</p>
|
|
2498
2498
|
* </li>
|
|
2499
2499
|
* <li>
|
|
2500
|
-
*
|
|
2500
|
+
* <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output
|
|
2501
2501
|
* artifact object. If you set the name to be a forward slash ("/"), the artifact
|
|
2502
2502
|
* is stored in the root of the output bucket.</p>
|
|
2503
2503
|
* </li>
|
|
2504
2504
|
* </ul>
|
|
2505
|
-
*
|
|
2506
|
-
*
|
|
2505
|
+
* <p>For example:</p>
|
|
2506
|
+
* <ul>
|
|
2507
2507
|
* <li>
|
|
2508
|
-
*
|
|
2508
|
+
* <p> If <code>path</code> is set to <code>MyArtifacts</code>,
|
|
2509
2509
|
* <code>namespaceType</code> is set to <code>BUILD_ID</code>, and
|
|
2510
2510
|
* <code>name</code> is set to <code>MyArtifact.zip</code>, then the output
|
|
2511
2511
|
* artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>. </p>
|
|
2512
2512
|
* </li>
|
|
2513
2513
|
* <li>
|
|
2514
|
-
*
|
|
2514
|
+
* <p> If <code>path</code> is empty, <code>namespaceType</code> is set to
|
|
2515
2515
|
* <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the
|
|
2516
2516
|
* output artifact is stored in the root of the output bucket. </p>
|
|
2517
2517
|
* </li>
|
|
2518
2518
|
* <li>
|
|
2519
|
-
*
|
|
2519
|
+
* <p> If <code>path</code> is set to <code>MyArtifacts</code>,
|
|
2520
2520
|
* <code>namespaceType</code> is set to <code>BUILD_ID</code>, and
|
|
2521
2521
|
* <code>name</code> is set to "<code>/</code>", the output artifact is stored
|
|
2522
2522
|
* in <code>MyArtifacts/<build-ID></code>. </p>
|
|
@@ -2527,30 +2527,30 @@ export interface ProjectArtifacts {
|
|
|
2527
2527
|
/**
|
|
2528
2528
|
* @public
|
|
2529
2529
|
* <p>The type of build output artifact to create:</p>
|
|
2530
|
-
*
|
|
2530
|
+
* <ul>
|
|
2531
2531
|
* <li>
|
|
2532
|
-
*
|
|
2532
|
+
* <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this
|
|
2533
2533
|
* value if specified. This is because CodePipeline manages its build output artifacts
|
|
2534
2534
|
* instead of CodeBuild.</p>
|
|
2535
2535
|
* </li>
|
|
2536
2536
|
* <li>
|
|
2537
|
-
*
|
|
2537
|
+
* <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is
|
|
2538
2538
|
* ignored if specified, because no build output is produced.</p>
|
|
2539
2539
|
* </li>
|
|
2540
2540
|
* <li>
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
2541
|
+
* <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p>
|
|
2542
|
+
* <ul>
|
|
2543
2543
|
* <li>
|
|
2544
|
-
*
|
|
2544
|
+
* <p>
|
|
2545
2545
|
* <code>NONE</code>: CodeBuild creates in the output bucket a folder that
|
|
2546
2546
|
* contains the build output. This is the default if <code>packaging</code>
|
|
2547
2547
|
* is not specified.</p>
|
|
2548
|
-
*
|
|
2548
|
+
* </li>
|
|
2549
2549
|
* <li>
|
|
2550
|
-
*
|
|
2550
|
+
* <p>
|
|
2551
2551
|
* <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that
|
|
2552
2552
|
* contains the build output.</p>
|
|
2553
|
-
*
|
|
2553
|
+
* </li>
|
|
2554
2554
|
* </ul>
|
|
2555
2555
|
* </li>
|
|
2556
2556
|
* </ul>
|
|
@@ -2582,40 +2582,40 @@ export interface ProjectArtifacts {
|
|
|
2582
2582
|
* Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has
|
|
2583
2583
|
* access to these objects. This property allows you to give the bucket owner access to
|
|
2584
2584
|
* these objects.</p>
|
|
2585
|
-
*
|
|
2585
|
+
* <note>
|
|
2586
2586
|
* <p>To use this property, your CodeBuild service role must have the
|
|
2587
2587
|
* <code>s3:PutBucketAcl</code> permission. This permission allows CodeBuild to modify
|
|
2588
2588
|
* the access control list for the bucket.</p>
|
|
2589
|
-
*
|
|
2590
|
-
*
|
|
2589
|
+
* </note>
|
|
2590
|
+
* <p>This property can be one of the following values:</p>
|
|
2591
2591
|
* <dl>
|
|
2592
2592
|
* <dt>NONE</dt>
|
|
2593
2593
|
* <dd>
|
|
2594
|
-
*
|
|
2594
|
+
* <p>The bucket owner does not have access to the objects. This is the
|
|
2595
2595
|
* default.</p>
|
|
2596
2596
|
* </dd>
|
|
2597
2597
|
* <dt>READ_ONLY</dt>
|
|
2598
2598
|
* <dd>
|
|
2599
|
-
*
|
|
2599
|
+
* <p>The bucket owner has read-only access to the objects. The uploading account
|
|
2600
2600
|
* retains ownership of the objects.</p>
|
|
2601
2601
|
* </dd>
|
|
2602
2602
|
* <dt>FULL</dt>
|
|
2603
2603
|
* <dd>
|
|
2604
|
-
*
|
|
2604
|
+
* <p>The bucket owner has full access to the objects. Object ownership is determined
|
|
2605
2605
|
* by the following criteria:</p>
|
|
2606
|
-
*
|
|
2606
|
+
* <ul>
|
|
2607
2607
|
* <li>
|
|
2608
|
-
*
|
|
2608
|
+
* <p>If the bucket is configured with the <b>Bucket
|
|
2609
2609
|
* owner preferred</b> setting, the bucket owner owns the
|
|
2610
2610
|
* objects. The uploading account will have object access as specified
|
|
2611
2611
|
* by the bucket's policy.</p>
|
|
2612
|
-
*
|
|
2612
|
+
* </li>
|
|
2613
2613
|
* <li>
|
|
2614
|
-
*
|
|
2614
|
+
* <p>Otherwise, the uploading account retains ownership of the
|
|
2615
2615
|
* objects.</p>
|
|
2616
|
-
*
|
|
2616
|
+
* </li>
|
|
2617
2617
|
* </ul>
|
|
2618
|
-
*
|
|
2618
|
+
* <p>For more information about Amazon S3 object ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of uploaded objects using S3
|
|
2619
2619
|
* Object Ownership</a> in the <i>Amazon Simple Storage Service User
|
|
2620
2620
|
* Guide</i>.</p>
|
|
2621
2621
|
* </dd>
|
|
@@ -2656,7 +2656,7 @@ export type ProjectVisibilityType = (typeof ProjectVisibilityType)[keyof typeof
|
|
|
2656
2656
|
/**
|
|
2657
2657
|
* @public
|
|
2658
2658
|
* <p>A tag, consisting of a key and a value.</p>
|
|
2659
|
-
*
|
|
2659
|
+
* <p>This tag is available for use by Amazon Web Services services that support tags in CodeBuild.</p>
|
|
2660
2660
|
*/
|
|
2661
2661
|
export interface Tag {
|
|
2662
2662
|
/**
|
|
@@ -2708,12 +2708,12 @@ export interface WebhookFilter {
|
|
|
2708
2708
|
* <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
|
|
2709
2709
|
* <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,
|
|
2710
2710
|
* <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>
|
|
2711
|
-
*
|
|
2711
|
+
* <dl>
|
|
2712
2712
|
* <dt>
|
|
2713
2713
|
* EVENT
|
|
2714
2714
|
* </dt>
|
|
2715
2715
|
* <dd>
|
|
2716
|
-
*
|
|
2716
|
+
* <p> A webhook event triggers a build when the provided <code>pattern</code>
|
|
2717
2717
|
* matches one of five event types: <code>PUSH</code>,
|
|
2718
2718
|
* <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>,
|
|
2719
2719
|
* <code>PULL_REQUEST_REOPENED</code>, and
|
|
@@ -2721,63 +2721,63 @@ export interface WebhookFilter {
|
|
|
2721
2721
|
* specified as a comma-separated string. For example, <code>PUSH,
|
|
2722
2722
|
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
|
|
2723
2723
|
* request created, and pull request updated events. </p>
|
|
2724
|
-
*
|
|
2725
|
-
*
|
|
2724
|
+
* <note>
|
|
2725
|
+
* <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
|
|
2726
2726
|
* Enterprise only. </p>
|
|
2727
|
-
*
|
|
2728
|
-
*
|
|
2727
|
+
* </note>
|
|
2728
|
+
* </dd>
|
|
2729
2729
|
* <dt>
|
|
2730
2730
|
* ACTOR_ACCOUNT_ID
|
|
2731
2731
|
* </dt>
|
|
2732
2732
|
* <dd>
|
|
2733
|
-
*
|
|
2733
|
+
* <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
|
|
2734
2734
|
* Bitbucket account ID matches the regular expression <code>pattern</code>.
|
|
2735
2735
|
* </p>
|
|
2736
|
-
*
|
|
2736
|
+
* </dd>
|
|
2737
2737
|
* <dt>
|
|
2738
2738
|
* HEAD_REF
|
|
2739
2739
|
* </dt>
|
|
2740
2740
|
* <dd>
|
|
2741
|
-
*
|
|
2741
|
+
* <p> A webhook event triggers a build when the head reference matches the
|
|
2742
2742
|
* regular expression <code>pattern</code>. For example,
|
|
2743
2743
|
* <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>
|
|
2744
|
-
*
|
|
2744
|
+
* <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
|
|
2745
2745
|
* Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
|
|
2746
2746
|
* </p>
|
|
2747
|
-
*
|
|
2747
|
+
* </dd>
|
|
2748
2748
|
* <dt>
|
|
2749
2749
|
* BASE_REF
|
|
2750
2750
|
* </dt>
|
|
2751
2751
|
* <dd>
|
|
2752
|
-
*
|
|
2752
|
+
* <p> A webhook event triggers a build when the base reference matches the
|
|
2753
2753
|
* regular expression <code>pattern</code>. For example,
|
|
2754
2754
|
* <code>refs/heads/branch-name</code>. </p>
|
|
2755
|
-
*
|
|
2756
|
-
*
|
|
2757
|
-
*
|
|
2758
|
-
*
|
|
2755
|
+
* <note>
|
|
2756
|
+
* <p> Works with pull request events only. </p>
|
|
2757
|
+
* </note>
|
|
2758
|
+
* </dd>
|
|
2759
2759
|
* <dt>
|
|
2760
2760
|
* FILE_PATH
|
|
2761
2761
|
* </dt>
|
|
2762
2762
|
* <dd>
|
|
2763
|
-
*
|
|
2763
|
+
* <p> A webhook triggers a build when the path of a changed file matches the
|
|
2764
2764
|
* regular expression <code>pattern</code>. </p>
|
|
2765
|
-
*
|
|
2766
|
-
*
|
|
2765
|
+
* <note>
|
|
2766
|
+
* <p> Works with GitHub and Bitbucket events push and pull requests events.
|
|
2767
2767
|
* Also works with GitHub Enterprise push events, but does not work with
|
|
2768
2768
|
* GitHub Enterprise pull request events. </p>
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2769
|
+
* </note>
|
|
2770
|
+
* </dd>
|
|
2771
2771
|
* <dt>COMMIT_MESSAGE</dt>
|
|
2772
2772
|
* <dd>
|
|
2773
|
-
*
|
|
2773
|
+
* <p>A webhook triggers a build when the head commit message matches the
|
|
2774
2774
|
* regular expression <code>pattern</code>.</p>
|
|
2775
|
-
*
|
|
2776
|
-
*
|
|
2775
|
+
* <note>
|
|
2776
|
+
* <p> Works with GitHub and Bitbucket events push and pull requests events.
|
|
2777
2777
|
* Also works with GitHub Enterprise push events, but does not work with
|
|
2778
2778
|
* GitHub Enterprise pull request events. </p>
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2779
|
+
* </note>
|
|
2780
|
+
* </dd>
|
|
2781
2781
|
* </dl>
|
|
2782
2782
|
*/
|
|
2783
2783
|
type: WebhookFilterType | string | undefined;
|
|
@@ -2787,7 +2787,7 @@ export interface WebhookFilter {
|
|
|
2787
2787
|
* string that specifies one or more events. For example, the webhook filter <code>PUSH,
|
|
2788
2788
|
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request
|
|
2789
2789
|
* created, and pull request updated events to trigger a build. </p>
|
|
2790
|
-
*
|
|
2790
|
+
* <p> For a <code>WebHookFilter</code> that uses any of the other filter types, a regular
|
|
2791
2791
|
* expression pattern. For example, a <code>WebHookFilter</code> that uses
|
|
2792
2792
|
* <code>HEAD_REF</code> for its <code>type</code> and the pattern
|
|
2793
2793
|
* <code>^refs/heads/</code> triggers a build when the head reference is a branch with
|
|
@@ -3048,7 +3048,6 @@ export interface Project {
|
|
|
3048
3048
|
/**
|
|
3049
3049
|
* @public
|
|
3050
3050
|
* <p>Specifies the visibility of the project's builds. Possible values are:</p>
|
|
3051
|
-
*
|
|
3052
3051
|
* <dl>
|
|
3053
3052
|
* <dt>PUBLIC_READ</dt>
|
|
3054
3053
|
* <dd>
|
|
@@ -3148,15 +3147,15 @@ export interface S3ReportExportConfig {
|
|
|
3148
3147
|
/**
|
|
3149
3148
|
* @public
|
|
3150
3149
|
* <p> The type of build output artifact to create. Valid values include: </p>
|
|
3151
|
-
*
|
|
3150
|
+
* <ul>
|
|
3152
3151
|
* <li>
|
|
3153
|
-
*
|
|
3154
|
-
*
|
|
3152
|
+
* <p>
|
|
3153
|
+
* <code>NONE</code>: CodeBuild creates the raw data in the output bucket. This
|
|
3155
3154
|
* is the default if packaging is not specified. </p>
|
|
3156
3155
|
* </li>
|
|
3157
3156
|
* <li>
|
|
3158
|
-
*
|
|
3159
|
-
*
|
|
3157
|
+
* <p>
|
|
3158
|
+
* <code>ZIP</code>: CodeBuild creates a ZIP file with the raw data in the
|
|
3160
3159
|
* output bucket. </p>
|
|
3161
3160
|
* </li>
|
|
3162
3161
|
* </ul>
|
|
@@ -3181,14 +3180,14 @@ export interface ReportExportConfig {
|
|
|
3181
3180
|
/**
|
|
3182
3181
|
* @public
|
|
3183
3182
|
* <p> The export configuration type. Valid values are: </p>
|
|
3184
|
-
*
|
|
3183
|
+
* <ul>
|
|
3185
3184
|
* <li>
|
|
3186
|
-
*
|
|
3187
|
-
*
|
|
3185
|
+
* <p>
|
|
3186
|
+
* <code>S3</code>: The report results are exported to an S3 bucket. </p>
|
|
3188
3187
|
* </li>
|
|
3189
3188
|
* <li>
|
|
3190
|
-
*
|
|
3191
|
-
*
|
|
3189
|
+
* <p>
|
|
3190
|
+
* <code>NO_EXPORT</code>: The report results are not exported. </p>
|
|
3192
3191
|
* </li>
|
|
3193
3192
|
* </ul>
|
|
3194
3193
|
*/
|
|
@@ -3278,7 +3277,7 @@ export interface ReportGroup {
|
|
|
3278
3277
|
/**
|
|
3279
3278
|
* @public
|
|
3280
3279
|
* <p>A list of tag key and value pairs associated with this report group. </p>
|
|
3281
|
-
*
|
|
3280
|
+
* <p>These tags are available for use by Amazon Web Services services that support CodeBuild report group
|
|
3282
3281
|
* tags.</p>
|
|
3283
3282
|
*/
|
|
3284
3283
|
tags?: Tag[];
|
|
@@ -3333,9 +3332,9 @@ export interface BatchGetReportsInput {
|
|
|
3333
3332
|
/**
|
|
3334
3333
|
* @public
|
|
3335
3334
|
* <p>Contains a summary of a code coverage report.</p>
|
|
3336
|
-
*
|
|
3335
|
+
* <p>Line coverage measures how many statements your tests cover. A statement is a single
|
|
3337
3336
|
* instruction, not including comments, conditionals, etc.</p>
|
|
3338
|
-
*
|
|
3337
|
+
* <p>Branch coverage determines if your tests cover every possible branch of a control
|
|
3339
3338
|
* structure, such as an <code>if</code> or <code>case</code> statement.</p>
|
|
3340
3339
|
*/
|
|
3341
3340
|
export interface CodeCoverageReportSummary {
|
|
@@ -4022,15 +4021,15 @@ export interface DescribeCodeCoveragesInput {
|
|
|
4022
4021
|
/**
|
|
4023
4022
|
* @public
|
|
4024
4023
|
* <p>Specifies how the results are sorted. Possible values are:</p>
|
|
4025
|
-
*
|
|
4024
|
+
* <dl>
|
|
4026
4025
|
* <dt>FILE_PATH</dt>
|
|
4027
4026
|
* <dd>
|
|
4028
|
-
*
|
|
4029
|
-
*
|
|
4027
|
+
* <p>The results are sorted by file path.</p>
|
|
4028
|
+
* </dd>
|
|
4030
4029
|
* <dt>LINE_COVERAGE_PERCENTAGE</dt>
|
|
4031
4030
|
* <dd>
|
|
4032
|
-
*
|
|
4033
|
-
*
|
|
4031
|
+
* <p>The results are sorted by the percentage of lines that are covered.</p>
|
|
4032
|
+
* </dd>
|
|
4034
4033
|
* </dl>
|
|
4035
4034
|
*/
|
|
4036
4035
|
sortBy?: ReportCodeCoverageSortByType | string;
|
|
@@ -4048,9 +4047,9 @@ export interface DescribeCodeCoveragesInput {
|
|
|
4048
4047
|
/**
|
|
4049
4048
|
* @public
|
|
4050
4049
|
* <p>Contains code coverage report information.</p>
|
|
4051
|
-
*
|
|
4050
|
+
* <p>Line coverage measures how many statements your tests cover. A statement is a single
|
|
4052
4051
|
* instruction, not including comments, conditionals, etc.</p>
|
|
4053
|
-
*
|
|
4052
|
+
* <p>Branch coverage determines if your tests cover every possible branch of a control
|
|
4054
4053
|
* structure, such as an <code>if</code> or <code>case</code> statement.</p>
|
|
4055
4054
|
*/
|
|
4056
4055
|
export interface CodeCoverage {
|
|
@@ -4131,29 +4130,29 @@ export interface TestCaseFilter {
|
|
|
4131
4130
|
* @public
|
|
4132
4131
|
* <p>The status used to filter test cases. A <code>TestCaseFilter</code> can have one
|
|
4133
4132
|
* status. Valid values are:</p>
|
|
4134
|
-
*
|
|
4133
|
+
* <ul>
|
|
4135
4134
|
* <li>
|
|
4136
|
-
*
|
|
4135
|
+
* <p>
|
|
4137
4136
|
* <code>SUCCEEDED</code>
|
|
4138
4137
|
* </p>
|
|
4139
4138
|
* </li>
|
|
4140
4139
|
* <li>
|
|
4141
|
-
*
|
|
4140
|
+
* <p>
|
|
4142
4141
|
* <code>FAILED</code>
|
|
4143
4142
|
* </p>
|
|
4144
4143
|
* </li>
|
|
4145
4144
|
* <li>
|
|
4146
|
-
*
|
|
4145
|
+
* <p>
|
|
4147
4146
|
* <code>ERROR</code>
|
|
4148
4147
|
* </p>
|
|
4149
4148
|
* </li>
|
|
4150
4149
|
* <li>
|
|
4151
|
-
*
|
|
4150
|
+
* <p>
|
|
4152
4151
|
* <code>SKIPPED</code>
|
|
4153
4152
|
* </p>
|
|
4154
4153
|
* </li>
|
|
4155
4154
|
* <li>
|
|
4156
|
-
*
|
|
4155
|
+
* <p>
|
|
4157
4156
|
* <code>UNKNOWN</code>
|
|
4158
4157
|
* </p>
|
|
4159
4158
|
* </li>
|
|
@@ -4313,7 +4312,7 @@ export interface GetReportGroupTrendInput {
|
|
|
4313
4312
|
* @public
|
|
4314
4313
|
* <p>The number of reports to analyze. This operation always retrieves the most recent
|
|
4315
4314
|
* reports.</p>
|
|
4316
|
-
*
|
|
4315
|
+
* <p>If this parameter is omitted, the most recent 100 reports are analyzed.</p>
|
|
4317
4316
|
*/
|
|
4318
4317
|
numOfReports?: number;
|
|
4319
4318
|
/**
|
|
@@ -4322,61 +4321,61 @@ export interface GetReportGroupTrendInput {
|
|
|
4322
4321
|
* <dl>
|
|
4323
4322
|
* <dt>Test reports:</dt>
|
|
4324
4323
|
* <dd>
|
|
4325
|
-
*
|
|
4324
|
+
* <dl>
|
|
4326
4325
|
* <dt>DURATION</dt>
|
|
4327
4326
|
* <dd>
|
|
4328
|
-
*
|
|
4327
|
+
* <p>Accumulate the test run times for the specified
|
|
4329
4328
|
* reports.</p>
|
|
4330
|
-
*
|
|
4329
|
+
* </dd>
|
|
4331
4330
|
* <dt>PASS_RATE</dt>
|
|
4332
4331
|
* <dd>
|
|
4333
|
-
*
|
|
4332
|
+
* <p>Accumulate the percentage of tests that passed for the
|
|
4334
4333
|
* specified test reports.</p>
|
|
4335
|
-
*
|
|
4334
|
+
* </dd>
|
|
4336
4335
|
* <dt>TOTAL</dt>
|
|
4337
4336
|
* <dd>
|
|
4338
|
-
*
|
|
4337
|
+
* <p>Accumulate the total number of tests for the specified test
|
|
4339
4338
|
* reports.</p>
|
|
4340
|
-
*
|
|
4339
|
+
* </dd>
|
|
4341
4340
|
* </dl>
|
|
4342
|
-
*
|
|
4341
|
+
* </dd>
|
|
4343
4342
|
* </dl>
|
|
4344
4343
|
* <dl>
|
|
4345
4344
|
* <dt>Code coverage reports:</dt>
|
|
4346
4345
|
* <dd>
|
|
4347
|
-
*
|
|
4346
|
+
* <dl>
|
|
4348
4347
|
* <dt>BRANCH_COVERAGE</dt>
|
|
4349
4348
|
* <dd>
|
|
4350
|
-
*
|
|
4349
|
+
* <p>Accumulate the branch coverage percentages for the specified
|
|
4351
4350
|
* test reports.</p>
|
|
4352
|
-
*
|
|
4351
|
+
* </dd>
|
|
4353
4352
|
* <dt>BRANCHES_COVERED</dt>
|
|
4354
4353
|
* <dd>
|
|
4355
|
-
*
|
|
4354
|
+
* <p>Accumulate the branches covered values for the specified test
|
|
4356
4355
|
* reports.</p>
|
|
4357
|
-
*
|
|
4356
|
+
* </dd>
|
|
4358
4357
|
* <dt>BRANCHES_MISSED</dt>
|
|
4359
4358
|
* <dd>
|
|
4360
|
-
*
|
|
4359
|
+
* <p>Accumulate the branches missed values for the specified test
|
|
4361
4360
|
* reports.</p>
|
|
4362
|
-
*
|
|
4361
|
+
* </dd>
|
|
4363
4362
|
* <dt>LINE_COVERAGE</dt>
|
|
4364
4363
|
* <dd>
|
|
4365
|
-
*
|
|
4364
|
+
* <p>Accumulate the line coverage percentages for the specified
|
|
4366
4365
|
* test reports.</p>
|
|
4367
|
-
*
|
|
4366
|
+
* </dd>
|
|
4368
4367
|
* <dt>LINES_COVERED</dt>
|
|
4369
4368
|
* <dd>
|
|
4370
|
-
*
|
|
4369
|
+
* <p>Accumulate the lines covered values for the specified test
|
|
4371
4370
|
* reports.</p>
|
|
4372
|
-
*
|
|
4371
|
+
* </dd>
|
|
4373
4372
|
* <dt>LINES_MISSED</dt>
|
|
4374
4373
|
* <dd>
|
|
4375
|
-
*
|
|
4374
|
+
* <p>Accumulate the lines not covered values for the specified test
|
|
4376
4375
|
* reports.</p>
|
|
4377
|
-
*
|
|
4376
|
+
* </dd>
|
|
4378
4377
|
* </dl>
|
|
4379
|
-
*
|
|
4378
|
+
* </dd>
|
|
4380
4379
|
* </dl>
|
|
4381
4380
|
*/
|
|
4382
4381
|
trendField: ReportGroupTrendFieldType | string | undefined;
|
|
@@ -4603,14 +4602,14 @@ export interface ListBuildBatchesForProjectInput {
|
|
|
4603
4602
|
/**
|
|
4604
4603
|
* @public
|
|
4605
4604
|
* <p>Specifies the sort order of the returned items. Valid values include:</p>
|
|
4606
|
-
*
|
|
4605
|
+
* <ul>
|
|
4607
4606
|
* <li>
|
|
4608
|
-
*
|
|
4607
|
+
* <p>
|
|
4609
4608
|
* <code>ASCENDING</code>: List the batch build identifiers in ascending order by
|
|
4610
4609
|
* identifier.</p>
|
|
4611
4610
|
* </li>
|
|
4612
4611
|
* <li>
|
|
4613
|
-
*
|
|
4612
|
+
* <p>
|
|
4614
4613
|
* <code>DESCENDING</code>: List the batch build identifiers in descending order
|
|
4615
4614
|
* by identifier.</p>
|
|
4616
4615
|
* </li>
|
|
@@ -4649,14 +4648,14 @@ export interface ListBuildsInput {
|
|
|
4649
4648
|
/**
|
|
4650
4649
|
* @public
|
|
4651
4650
|
* <p>The order to list build IDs. Valid values include:</p>
|
|
4652
|
-
*
|
|
4651
|
+
* <ul>
|
|
4653
4652
|
* <li>
|
|
4654
|
-
*
|
|
4653
|
+
* <p>
|
|
4655
4654
|
* <code>ASCENDING</code>: List the build IDs in ascending order by build
|
|
4656
4655
|
* ID.</p>
|
|
4657
4656
|
* </li>
|
|
4658
4657
|
* <li>
|
|
4659
|
-
*
|
|
4658
|
+
* <p>
|
|
4660
4659
|
* <code>DESCENDING</code>: List the build IDs in descending order by build
|
|
4661
4660
|
* ID.</p>
|
|
4662
4661
|
* </li>
|
|
@@ -4705,18 +4704,18 @@ export interface ListBuildsForProjectInput {
|
|
|
4705
4704
|
* @public
|
|
4706
4705
|
* <p>The order to sort the results in. The results are sorted by build number, not the build
|
|
4707
4706
|
* identifier. If this is not specified, the results are sorted in descending order.</p>
|
|
4708
|
-
*
|
|
4709
|
-
*
|
|
4707
|
+
* <p>Valid values include:</p>
|
|
4708
|
+
* <ul>
|
|
4710
4709
|
* <li>
|
|
4711
|
-
*
|
|
4710
|
+
* <p>
|
|
4712
4711
|
* <code>ASCENDING</code>: List the build identifiers in ascending order, by build number.</p>
|
|
4713
4712
|
* </li>
|
|
4714
4713
|
* <li>
|
|
4715
|
-
*
|
|
4714
|
+
* <p>
|
|
4716
4715
|
* <code>DESCENDING</code>: List the build identifiers in descending order, by build number.</p>
|
|
4717
4716
|
* </li>
|
|
4718
4717
|
* </ul>
|
|
4719
|
-
*
|
|
4718
|
+
* <p>If the project has more than 100 builds, setting the sort order will result in an
|
|
4720
4719
|
* error. </p>
|
|
4721
4720
|
*/
|
|
4722
4721
|
sortOrder?: SortOrderType | string;
|
|
@@ -4876,40 +4875,40 @@ export interface ListProjectsInput {
|
|
|
4876
4875
|
/**
|
|
4877
4876
|
* @public
|
|
4878
4877
|
* <p>The criterion to be used to list build project names. Valid values include:</p>
|
|
4879
|
-
*
|
|
4878
|
+
* <ul>
|
|
4880
4879
|
* <li>
|
|
4881
|
-
*
|
|
4880
|
+
* <p>
|
|
4882
4881
|
* <code>CREATED_TIME</code>: List based on when each build project was
|
|
4883
4882
|
* created.</p>
|
|
4884
4883
|
* </li>
|
|
4885
4884
|
* <li>
|
|
4886
|
-
*
|
|
4885
|
+
* <p>
|
|
4887
4886
|
* <code>LAST_MODIFIED_TIME</code>: List based on when information about each
|
|
4888
4887
|
* build project was last changed.</p>
|
|
4889
4888
|
* </li>
|
|
4890
4889
|
* <li>
|
|
4891
|
-
*
|
|
4890
|
+
* <p>
|
|
4892
4891
|
* <code>NAME</code>: List based on each build project's name.</p>
|
|
4893
4892
|
* </li>
|
|
4894
4893
|
* </ul>
|
|
4895
|
-
*
|
|
4894
|
+
* <p>Use <code>sortOrder</code> to specify in what order to list the build project names
|
|
4896
4895
|
* based on the preceding criteria.</p>
|
|
4897
4896
|
*/
|
|
4898
4897
|
sortBy?: ProjectSortByType | string;
|
|
4899
4898
|
/**
|
|
4900
4899
|
* @public
|
|
4901
4900
|
* <p>The order in which to list build projects. Valid values include:</p>
|
|
4902
|
-
*
|
|
4901
|
+
* <ul>
|
|
4903
4902
|
* <li>
|
|
4904
|
-
*
|
|
4903
|
+
* <p>
|
|
4905
4904
|
* <code>ASCENDING</code>: List in ascending order.</p>
|
|
4906
4905
|
* </li>
|
|
4907
4906
|
* <li>
|
|
4908
|
-
*
|
|
4907
|
+
* <p>
|
|
4909
4908
|
* <code>DESCENDING</code>: List in descending order.</p>
|
|
4910
4909
|
* </li>
|
|
4911
4910
|
* </ul>
|
|
4912
|
-
*
|
|
4911
|
+
* <p>Use <code>sortBy</code> to specify the criterion to be used to list build project
|
|
4913
4912
|
* names.</p>
|
|
4914
4913
|
*/
|
|
4915
4914
|
sortOrder?: SortOrderType | string;
|
|
@@ -5206,14 +5205,14 @@ export interface ListSharedProjectsInput {
|
|
|
5206
5205
|
* @public
|
|
5207
5206
|
* <p> The criterion to be used to list build projects shared with the current Amazon Web Services account
|
|
5208
5207
|
* or user. Valid values include: </p>
|
|
5209
|
-
*
|
|
5208
|
+
* <ul>
|
|
5210
5209
|
* <li>
|
|
5211
|
-
*
|
|
5212
|
-
*
|
|
5210
|
+
* <p>
|
|
5211
|
+
* <code>ARN</code>: List based on the ARN. </p>
|
|
5213
5212
|
* </li>
|
|
5214
5213
|
* <li>
|
|
5215
|
-
*
|
|
5216
|
-
*
|
|
5214
|
+
* <p>
|
|
5215
|
+
* <code>MODIFIED_TIME</code>: List based on when information about the shared
|
|
5217
5216
|
* project was last changed. </p>
|
|
5218
5217
|
* </li>
|
|
5219
5218
|
* </ul>
|
|
@@ -5222,13 +5221,13 @@ export interface ListSharedProjectsInput {
|
|
|
5222
5221
|
/**
|
|
5223
5222
|
* @public
|
|
5224
5223
|
* <p>The order in which to list shared build projects. Valid values include:</p>
|
|
5225
|
-
*
|
|
5224
|
+
* <ul>
|
|
5226
5225
|
* <li>
|
|
5227
|
-
*
|
|
5226
|
+
* <p>
|
|
5228
5227
|
* <code>ASCENDING</code>: List in ascending order.</p>
|
|
5229
5228
|
* </li>
|
|
5230
5229
|
* <li>
|
|
5231
|
-
*
|
|
5230
|
+
* <p>
|
|
5232
5231
|
* <code>DESCENDING</code>: List in descending order.</p>
|
|
5233
5232
|
* </li>
|
|
5234
5233
|
* </ul>
|
|
@@ -5280,13 +5279,13 @@ export interface ListSharedReportGroupsInput {
|
|
|
5280
5279
|
/**
|
|
5281
5280
|
* @public
|
|
5282
5281
|
* <p>The order in which to list shared report groups. Valid values include:</p>
|
|
5283
|
-
*
|
|
5282
|
+
* <ul>
|
|
5284
5283
|
* <li>
|
|
5285
|
-
*
|
|
5284
|
+
* <p>
|
|
5286
5285
|
* <code>ASCENDING</code>: List in ascending order.</p>
|
|
5287
5286
|
* </li>
|
|
5288
5287
|
* <li>
|
|
5289
|
-
*
|
|
5288
|
+
* <p>
|
|
5290
5289
|
* <code>DESCENDING</code>: List in descending order.</p>
|
|
5291
5290
|
* </li>
|
|
5292
5291
|
* </ul>
|
|
@@ -5296,14 +5295,14 @@ export interface ListSharedReportGroupsInput {
|
|
|
5296
5295
|
* @public
|
|
5297
5296
|
* <p> The criterion to be used to list report groups shared with the current Amazon Web Services account or
|
|
5298
5297
|
* user. Valid values include: </p>
|
|
5299
|
-
*
|
|
5298
|
+
* <ul>
|
|
5300
5299
|
* <li>
|
|
5301
|
-
*
|
|
5302
|
-
*
|
|
5300
|
+
* <p>
|
|
5301
|
+
* <code>ARN</code>: List based on the ARN. </p>
|
|
5303
5302
|
* </li>
|
|
5304
5303
|
* <li>
|
|
5305
|
-
*
|
|
5306
|
-
*
|
|
5304
|
+
* <p>
|
|
5305
|
+
* <code>MODIFIED_TIME</code>: List based on when information about the shared
|
|
5307
5306
|
* report group was last changed. </p>
|
|
5308
5307
|
* </li>
|
|
5309
5308
|
* </ul>
|
|
@@ -5518,36 +5517,36 @@ export interface StartBuildInput {
|
|
|
5518
5517
|
* <p>The version of the build input to be built, for this build only. If not specified,
|
|
5519
5518
|
* the latest version is used. If specified, the contents depends on the source
|
|
5520
5519
|
* provider:</p>
|
|
5521
|
-
*
|
|
5520
|
+
* <dl>
|
|
5522
5521
|
* <dt>CodeCommit</dt>
|
|
5523
5522
|
* <dd>
|
|
5524
|
-
*
|
|
5525
|
-
*
|
|
5523
|
+
* <p>The commit ID, branch, or Git tag to use.</p>
|
|
5524
|
+
* </dd>
|
|
5526
5525
|
* <dt>GitHub</dt>
|
|
5527
5526
|
* <dd>
|
|
5528
|
-
*
|
|
5527
|
+
* <p>The commit ID, pull request ID, branch name, or tag name that corresponds
|
|
5529
5528
|
* to the version of the source code you want to build. If a pull request ID is
|
|
5530
5529
|
* specified, it must use the format <code>pr/pull-request-ID</code> (for
|
|
5531
5530
|
* example <code>pr/25</code>). If a branch name is specified, the branch's
|
|
5532
5531
|
* HEAD commit ID is used. If not specified, the default branch's HEAD commit
|
|
5533
5532
|
* ID is used.</p>
|
|
5534
|
-
*
|
|
5533
|
+
* </dd>
|
|
5535
5534
|
* <dt>Bitbucket</dt>
|
|
5536
5535
|
* <dd>
|
|
5537
|
-
*
|
|
5536
|
+
* <p>The commit ID, branch name, or tag name that corresponds to the version of
|
|
5538
5537
|
* the source code you want to build. If a branch name is specified, the
|
|
5539
5538
|
* branch's HEAD commit ID is used. If not specified, the default branch's HEAD
|
|
5540
5539
|
* commit ID is used.</p>
|
|
5541
|
-
*
|
|
5540
|
+
* </dd>
|
|
5542
5541
|
* <dt>Amazon S3</dt>
|
|
5543
5542
|
* <dd>
|
|
5544
|
-
*
|
|
5543
|
+
* <p>The version ID of the object that represents the build input ZIP file to
|
|
5545
5544
|
* use.</p>
|
|
5546
|
-
*
|
|
5545
|
+
* </dd>
|
|
5547
5546
|
* </dl>
|
|
5548
|
-
*
|
|
5547
|
+
* <p>If <code>sourceVersion</code> is specified at the project level, then this
|
|
5549
5548
|
* <code>sourceVersion</code> (at the build level) takes precedence. </p>
|
|
5550
|
-
*
|
|
5549
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample
|
|
5551
5550
|
* with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
|
|
5552
5551
|
*/
|
|
5553
5552
|
sourceVersion?: string;
|
|
@@ -5603,7 +5602,7 @@ export interface StartBuildInput {
|
|
|
5603
5602
|
* @public
|
|
5604
5603
|
* <p>A buildspec file declaration that overrides, for this build only, the latest one
|
|
5605
5604
|
* already defined in the build project.</p>
|
|
5606
|
-
*
|
|
5605
|
+
* <p> If this value is set, it can be either an inline buildspec definition, the path to an
|
|
5607
5606
|
* alternate buildspec file relative to the value of the built-in
|
|
5608
5607
|
* <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket.
|
|
5609
5608
|
* The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
|
|
@@ -5626,12 +5625,12 @@ export interface StartBuildInput {
|
|
|
5626
5625
|
* <p> Set to true to report to your source provider the status of a build's start and
|
|
5627
5626
|
* completion. If you use this option with a source provider other than GitHub, GitHub
|
|
5628
5627
|
* Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </p>
|
|
5629
|
-
*
|
|
5628
|
+
* <p>To be able to report the build status to the source provider, the user associated with the source provider must
|
|
5630
5629
|
* have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p>
|
|
5631
|
-
*
|
|
5630
|
+
* <note>
|
|
5632
5631
|
* <p> The status of a build triggered by a webhook is always reported to your source
|
|
5633
5632
|
* provider. </p>
|
|
5634
|
-
*
|
|
5633
|
+
* </note>
|
|
5635
5634
|
*/
|
|
5636
5635
|
reportBuildStatusOverride?: boolean;
|
|
5637
5636
|
/**
|
|
@@ -5698,11 +5697,11 @@ export interface StartBuildInput {
|
|
|
5698
5697
|
* @public
|
|
5699
5698
|
* <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build
|
|
5700
5699
|
* project. The CMK key encrypts the build output artifacts.</p>
|
|
5701
|
-
*
|
|
5700
|
+
* <note>
|
|
5702
5701
|
* <p> You can use a cross-account KMS key to encrypt the build output artifacts if your
|
|
5703
5702
|
* service role has permission to that key. </p>
|
|
5704
|
-
*
|
|
5705
|
-
*
|
|
5703
|
+
* </note>
|
|
5704
|
+
* <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
|
|
5706
5705
|
* the format <code>alias/<alias-name></code>).</p>
|
|
5707
5706
|
*/
|
|
5708
5707
|
encryptionKeyOverride?: string;
|
|
@@ -5729,18 +5728,18 @@ export interface StartBuildInput {
|
|
|
5729
5728
|
* @public
|
|
5730
5729
|
* <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid
|
|
5731
5730
|
* values: </p>
|
|
5732
|
-
*
|
|
5731
|
+
* <dl>
|
|
5733
5732
|
* <dt>CODEBUILD</dt>
|
|
5734
5733
|
* <dd>
|
|
5735
|
-
*
|
|
5734
|
+
* <p>Specifies that CodeBuild uses its own credentials. This requires that you
|
|
5736
5735
|
* modify your ECR repository policy to trust CodeBuild's service principal.</p>
|
|
5737
|
-
*
|
|
5736
|
+
* </dd>
|
|
5738
5737
|
* <dt>SERVICE_ROLE</dt>
|
|
5739
5738
|
* <dd>
|
|
5740
|
-
*
|
|
5741
|
-
*
|
|
5739
|
+
* <p>Specifies that CodeBuild uses your build project's service role. </p>
|
|
5740
|
+
* </dd>
|
|
5742
5741
|
* </dl>
|
|
5743
|
-
*
|
|
5742
|
+
* <p>When using a cross-account or private registry image, you must use
|
|
5744
5743
|
* <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image,
|
|
5745
5744
|
* you must use <code>CODEBUILD</code> credentials. </p>
|
|
5746
5745
|
*/
|
|
@@ -5788,32 +5787,32 @@ export interface StartBuildBatchInput {
|
|
|
5788
5787
|
* <p>The version of the batch build input to be built, for this build only. If not specified,
|
|
5789
5788
|
* the latest version is used. If specified, the contents depends on the source
|
|
5790
5789
|
* provider:</p>
|
|
5791
|
-
*
|
|
5790
|
+
* <dl>
|
|
5792
5791
|
* <dt>CodeCommit</dt>
|
|
5793
5792
|
* <dd>
|
|
5794
|
-
*
|
|
5795
|
-
*
|
|
5793
|
+
* <p>The commit ID, branch, or Git tag to use.</p>
|
|
5794
|
+
* </dd>
|
|
5796
5795
|
* <dt>GitHub</dt>
|
|
5797
5796
|
* <dd>
|
|
5798
|
-
*
|
|
5797
|
+
* <p>The commit ID, pull request ID, branch name, or tag name that corresponds
|
|
5799
5798
|
* to the version of the source code you want to build. If a pull request ID is
|
|
5800
5799
|
* specified, it must use the format <code>pr/pull-request-ID</code> (for
|
|
5801
5800
|
* example <code>pr/25</code>). If a branch name is specified, the branch's
|
|
5802
5801
|
* HEAD commit ID is used. If not specified, the default branch's HEAD commit
|
|
5803
5802
|
* ID is used.</p>
|
|
5804
|
-
*
|
|
5803
|
+
* </dd>
|
|
5805
5804
|
* <dt>Bitbucket</dt>
|
|
5806
5805
|
* <dd>
|
|
5807
|
-
*
|
|
5806
|
+
* <p>The commit ID, branch name, or tag name that corresponds to the version of
|
|
5808
5807
|
* the source code you want to build. If a branch name is specified, the
|
|
5809
5808
|
* branch's HEAD commit ID is used. If not specified, the default branch's HEAD
|
|
5810
5809
|
* commit ID is used.</p>
|
|
5811
|
-
*
|
|
5810
|
+
* </dd>
|
|
5812
5811
|
* <dt>Amazon S3</dt>
|
|
5813
5812
|
* <dd>
|
|
5814
|
-
*
|
|
5813
|
+
* <p>The version ID of the object that represents the build input ZIP file to
|
|
5815
5814
|
* use.</p>
|
|
5816
|
-
*
|
|
5815
|
+
* </dd>
|
|
5817
5816
|
* </dl>
|
|
5818
5817
|
* <p>If <code>sourceVersion</code> is specified at the project level, then this
|
|
5819
5818
|
* <code>sourceVersion</code> (at the build level) takes precedence. </p>
|
|
@@ -5990,16 +5989,16 @@ export interface StartBuildBatchInput {
|
|
|
5990
5989
|
* @public
|
|
5991
5990
|
* <p>The type of credentials CodeBuild uses to pull images in your batch build. There are two valid
|
|
5992
5991
|
* values: </p>
|
|
5993
|
-
*
|
|
5992
|
+
* <dl>
|
|
5994
5993
|
* <dt>CODEBUILD</dt>
|
|
5995
5994
|
* <dd>
|
|
5996
|
-
*
|
|
5995
|
+
* <p>Specifies that CodeBuild uses its own credentials. This requires that you
|
|
5997
5996
|
* modify your ECR repository policy to trust CodeBuild's service principal.</p>
|
|
5998
|
-
*
|
|
5997
|
+
* </dd>
|
|
5999
5998
|
* <dt>SERVICE_ROLE</dt>
|
|
6000
5999
|
* <dd>
|
|
6001
|
-
*
|
|
6002
|
-
*
|
|
6000
|
+
* <p>Specifies that CodeBuild uses your build project's service role. </p>
|
|
6001
|
+
* </dd>
|
|
6003
6002
|
* </dl>
|
|
6004
6003
|
* <p>When using a cross-account or private registry image, you must use
|
|
6005
6004
|
* <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image,
|
|
@@ -6259,7 +6258,6 @@ export interface UpdateProjectVisibilityInput {
|
|
|
6259
6258
|
/**
|
|
6260
6259
|
* @public
|
|
6261
6260
|
* <p>Specifies the visibility of the project's builds. Possible values are:</p>
|
|
6262
|
-
*
|
|
6263
6261
|
* <dl>
|
|
6264
6262
|
* <dt>PUBLIC_READ</dt>
|
|
6265
6263
|
* <dd>
|
|
@@ -6296,7 +6294,6 @@ export interface UpdateProjectVisibilityOutput {
|
|
|
6296
6294
|
/**
|
|
6297
6295
|
* @public
|
|
6298
6296
|
* <p>Specifies the visibility of the project's builds. Possible values are:</p>
|
|
6299
|
-
*
|
|
6300
6297
|
* <dl>
|
|
6301
6298
|
* <dt>PUBLIC_READ</dt>
|
|
6302
6299
|
* <dd>
|