aws-sdk 2.965.0 → 2.966.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/CHANGELOG.md +6 -1
- package/README.md +1 -1
- package/apis/codebuild-2016-10-06.examples.json +0 -276
- package/apis/codebuild-2016-10-06.min.json +51 -26
- package/apis/metadata.json +4 -0
- package/apis/nimble-2020-08-01.min.json +13 -0
- package/apis/snow-device-management-2021-08-04.examples.json +5 -0
- package/apis/snow-device-management-2021-08-04.min.json +638 -0
- package/apis/snow-device-management-2021-08-04.paginators.json +28 -0
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/codebuild.d.ts +166 -126
- package/clients/ebs.d.ts +10 -10
- package/clients/ecs.d.ts +18 -18
- package/clients/nimble.d.ts +31 -15
- package/clients/route53.d.ts +57 -57
- package/clients/snowdevicemanagement.d.ts +767 -0
- package/clients/snowdevicemanagement.js +18 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +43 -6
- package/dist/aws-sdk.js +58 -29
- package/dist/aws-sdk.min.js +76 -76
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/codebuild.d.ts
CHANGED
|
@@ -76,11 +76,11 @@ declare class CodeBuild extends Service {
|
|
|
76
76
|
*/
|
|
77
77
|
createReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* For an existing
|
|
79
|
+
* For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
|
|
80
80
|
*/
|
|
81
81
|
createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* For an existing
|
|
83
|
+
* For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
|
|
84
84
|
*/
|
|
85
85
|
createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
|
|
86
86
|
/**
|
|
@@ -132,11 +132,11 @@ declare class CodeBuild extends Service {
|
|
|
132
132
|
*/
|
|
133
133
|
deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* For an existing
|
|
135
|
+
* For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
|
|
136
136
|
*/
|
|
137
137
|
deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* For an existing
|
|
139
|
+
* For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
|
|
140
140
|
*/
|
|
141
141
|
deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
|
|
142
142
|
/**
|
|
@@ -172,11 +172,11 @@ declare class CodeBuild extends Service {
|
|
|
172
172
|
*/
|
|
173
173
|
getResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
* Imports the source repository credentials for an
|
|
175
|
+
* Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
|
|
176
176
|
*/
|
|
177
177
|
importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
* Imports the source repository credentials for an
|
|
179
|
+
* Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
|
|
180
180
|
*/
|
|
181
181
|
importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
|
|
182
182
|
/**
|
|
@@ -220,11 +220,11 @@ declare class CodeBuild extends Service {
|
|
|
220
220
|
*/
|
|
221
221
|
listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
|
|
222
222
|
/**
|
|
223
|
-
* Gets information about Docker images that are managed by
|
|
223
|
+
* Gets information about Docker images that are managed by CodeBuild.
|
|
224
224
|
*/
|
|
225
225
|
listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
|
|
226
226
|
/**
|
|
227
|
-
* Gets information about Docker images that are managed by
|
|
227
|
+
* Gets information about Docker images that are managed by CodeBuild.
|
|
228
228
|
*/
|
|
229
229
|
listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
|
|
230
230
|
/**
|
|
@@ -236,19 +236,19 @@ declare class CodeBuild extends Service {
|
|
|
236
236
|
*/
|
|
237
237
|
listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
|
|
238
238
|
/**
|
|
239
|
-
* Gets a list ARNs for the report groups in the current
|
|
239
|
+
* Gets a list ARNs for the report groups in the current Amazon Web Services account.
|
|
240
240
|
*/
|
|
241
241
|
listReportGroups(params: CodeBuild.Types.ListReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
|
|
242
242
|
/**
|
|
243
|
-
* Gets a list ARNs for the report groups in the current
|
|
243
|
+
* Gets a list ARNs for the report groups in the current Amazon Web Services account.
|
|
244
244
|
*/
|
|
245
245
|
listReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
|
|
246
246
|
/**
|
|
247
|
-
* Returns a list of ARNs for the reports in the current
|
|
247
|
+
* Returns a list of ARNs for the reports in the current Amazon Web Services account.
|
|
248
248
|
*/
|
|
249
249
|
listReports(params: CodeBuild.Types.ListReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
|
|
250
250
|
/**
|
|
251
|
-
* Returns a list of ARNs for the reports in the current
|
|
251
|
+
* Returns a list of ARNs for the reports in the current Amazon Web Services account.
|
|
252
252
|
*/
|
|
253
253
|
listReports(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
|
|
254
254
|
/**
|
|
@@ -260,19 +260,19 @@ declare class CodeBuild extends Service {
|
|
|
260
260
|
*/
|
|
261
261
|
listReportsForReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>;
|
|
262
262
|
/**
|
|
263
|
-
* Gets a list of projects that are shared with other
|
|
263
|
+
* Gets a list of projects that are shared with other Amazon Web Services accounts or users.
|
|
264
264
|
*/
|
|
265
265
|
listSharedProjects(params: CodeBuild.Types.ListSharedProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
|
|
266
266
|
/**
|
|
267
|
-
* Gets a list of projects that are shared with other
|
|
267
|
+
* Gets a list of projects that are shared with other Amazon Web Services accounts or users.
|
|
268
268
|
*/
|
|
269
269
|
listSharedProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
|
|
270
270
|
/**
|
|
271
|
-
* Gets a list of report groups that are shared with other
|
|
271
|
+
* Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
|
|
272
272
|
*/
|
|
273
273
|
listSharedReportGroups(params: CodeBuild.Types.ListSharedReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
|
|
274
274
|
/**
|
|
275
|
-
* Gets a list of report groups that are shared with other
|
|
275
|
+
* Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
|
|
276
276
|
*/
|
|
277
277
|
listSharedReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
|
|
278
278
|
/**
|
|
@@ -347,6 +347,14 @@ declare class CodeBuild extends Service {
|
|
|
347
347
|
* Changes the settings of a build project.
|
|
348
348
|
*/
|
|
349
349
|
updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
|
|
350
|
+
/**
|
|
351
|
+
* Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide. The following should be kept in mind when making your projects public: All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
|
|
352
|
+
*/
|
|
353
|
+
updateProjectVisibility(params: CodeBuild.Types.UpdateProjectVisibilityInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>;
|
|
354
|
+
/**
|
|
355
|
+
* Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide. The following should be kept in mind when making your projects public: All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
|
|
356
|
+
*/
|
|
357
|
+
updateProjectVisibility(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>;
|
|
350
358
|
/**
|
|
351
359
|
* Updates a report group.
|
|
352
360
|
*/
|
|
@@ -356,11 +364,11 @@ declare class CodeBuild extends Service {
|
|
|
356
364
|
*/
|
|
357
365
|
updateReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>;
|
|
358
366
|
/**
|
|
359
|
-
* Updates the webhook associated with an
|
|
367
|
+
* Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
|
|
360
368
|
*/
|
|
361
369
|
updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
|
|
362
370
|
/**
|
|
363
|
-
* Updates the webhook associated with an
|
|
371
|
+
* Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
|
|
364
372
|
*/
|
|
365
373
|
updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
|
|
366
374
|
}
|
|
@@ -419,7 +427,7 @@ declare namespace CodeBuild {
|
|
|
419
427
|
}
|
|
420
428
|
export interface BatchGetProjectsInput {
|
|
421
429
|
/**
|
|
422
|
-
* The names or ARNs of the build projects. To get information about a project shared with your
|
|
430
|
+
* The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
|
|
423
431
|
*/
|
|
424
432
|
names: ProjectNames;
|
|
425
433
|
}
|
|
@@ -471,7 +479,7 @@ declare namespace CodeBuild {
|
|
|
471
479
|
*/
|
|
472
480
|
maximumBuildsAllowed?: WrapperInt;
|
|
473
481
|
/**
|
|
474
|
-
* An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the
|
|
482
|
+
* An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
|
|
475
483
|
*/
|
|
476
484
|
computeTypesAllowed?: ComputeTypesAllowed;
|
|
477
485
|
}
|
|
@@ -507,15 +515,15 @@ declare namespace CodeBuild {
|
|
|
507
515
|
*/
|
|
508
516
|
buildStatus?: StatusType;
|
|
509
517
|
/**
|
|
510
|
-
* Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the
|
|
518
|
+
* Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
511
519
|
*/
|
|
512
520
|
sourceVersion?: NonEmptyString;
|
|
513
521
|
/**
|
|
514
|
-
* An identifier for the version of this build's source code. For
|
|
522
|
+
* An identifier for the version of this build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply.
|
|
515
523
|
*/
|
|
516
524
|
resolvedSourceVersion?: NonEmptyString;
|
|
517
525
|
/**
|
|
518
|
-
* The name of the
|
|
526
|
+
* The name of the CodeBuild project.
|
|
519
527
|
*/
|
|
520
528
|
projectName?: NonEmptyString;
|
|
521
529
|
/**
|
|
@@ -531,7 +539,7 @@ declare namespace CodeBuild {
|
|
|
531
539
|
*/
|
|
532
540
|
secondarySources?: ProjectSources;
|
|
533
541
|
/**
|
|
534
|
-
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For
|
|
542
|
+
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
|
|
535
543
|
*/
|
|
536
544
|
secondarySourceVersions?: ProjectSecondarySourceVersions;
|
|
537
545
|
/**
|
|
@@ -555,11 +563,11 @@ declare namespace CodeBuild {
|
|
|
555
563
|
*/
|
|
556
564
|
serviceRole?: NonEmptyString;
|
|
557
565
|
/**
|
|
558
|
-
* Information about the build's logs in
|
|
566
|
+
* Information about the build's logs in CloudWatch Logs.
|
|
559
567
|
*/
|
|
560
568
|
logs?: LogsLocation;
|
|
561
569
|
/**
|
|
562
|
-
* How long, in minutes, for
|
|
570
|
+
* How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
|
|
563
571
|
*/
|
|
564
572
|
timeoutInMinutes?: WrapperInt;
|
|
565
573
|
/**
|
|
@@ -571,11 +579,11 @@ declare namespace CodeBuild {
|
|
|
571
579
|
*/
|
|
572
580
|
buildComplete?: Boolean;
|
|
573
581
|
/**
|
|
574
|
-
* The entity that started the build. Valid values include: If
|
|
582
|
+
* The entity that started the build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an IAM user started the build, the user's name (for example, MyUserName). If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
|
|
575
583
|
*/
|
|
576
584
|
initiator?: String;
|
|
577
585
|
/**
|
|
578
|
-
* If your
|
|
586
|
+
* If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
|
|
579
587
|
*/
|
|
580
588
|
vpcConfig?: VpcConfig;
|
|
581
589
|
/**
|
|
@@ -583,11 +591,11 @@ declare namespace CodeBuild {
|
|
|
583
591
|
*/
|
|
584
592
|
networkInterface?: NetworkInterface;
|
|
585
593
|
/**
|
|
586
|
-
* The
|
|
594
|
+
* The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
587
595
|
*/
|
|
588
596
|
encryptionKey?: NonEmptyString;
|
|
589
597
|
/**
|
|
590
|
-
* A list of exported environment variables for this build. Exported environment variables are used in conjunction with
|
|
598
|
+
* A list of exported environment variables for this build. Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
|
|
591
599
|
*/
|
|
592
600
|
exportedEnvironmentVariables?: ExportedEnvironmentVariables;
|
|
593
601
|
/**
|
|
@@ -665,7 +673,7 @@ declare namespace CodeBuild {
|
|
|
665
673
|
*/
|
|
666
674
|
sourceVersion?: NonEmptyString;
|
|
667
675
|
/**
|
|
668
|
-
* The identifier of the resolved version of this batch build's source code. For
|
|
676
|
+
* The identifier of the resolved version of this batch build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply.
|
|
669
677
|
*/
|
|
670
678
|
resolvedSourceVersion?: NonEmptyString;
|
|
671
679
|
/**
|
|
@@ -682,7 +690,7 @@ declare namespace CodeBuild {
|
|
|
682
690
|
*/
|
|
683
691
|
secondarySources?: ProjectSources;
|
|
684
692
|
/**
|
|
685
|
-
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For
|
|
693
|
+
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
|
|
686
694
|
*/
|
|
687
695
|
secondarySourceVersions?: ProjectSecondarySourceVersions;
|
|
688
696
|
/**
|
|
@@ -713,12 +721,12 @@ declare namespace CodeBuild {
|
|
|
713
721
|
*/
|
|
714
722
|
complete?: Boolean;
|
|
715
723
|
/**
|
|
716
|
-
* The entity that started the batch build. Valid values include: If
|
|
724
|
+
* The entity that started the batch build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If an IAM user started the build, the user's name. If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
|
|
717
725
|
*/
|
|
718
726
|
initiator?: String;
|
|
719
727
|
vpcConfig?: VpcConfig;
|
|
720
728
|
/**
|
|
721
|
-
* The
|
|
729
|
+
* The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
722
730
|
*/
|
|
723
731
|
encryptionKey?: NonEmptyString;
|
|
724
732
|
/**
|
|
@@ -877,15 +885,15 @@ declare namespace CodeBuild {
|
|
|
877
885
|
export type CacheType = "NO_CACHE"|"S3"|"LOCAL"|string;
|
|
878
886
|
export interface CloudWatchLogsConfig {
|
|
879
887
|
/**
|
|
880
|
-
* The current status of the logs in
|
|
888
|
+
* The current status of the logs in CloudWatch Logs for a build project. Valid values are: ENABLED: CloudWatch Logs are enabled for this build project. DISABLED: CloudWatch Logs are not enabled for this build project.
|
|
881
889
|
*/
|
|
882
890
|
status: LogsConfigStatusType;
|
|
883
891
|
/**
|
|
884
|
-
* The group name of the logs in
|
|
892
|
+
* The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
|
|
885
893
|
*/
|
|
886
894
|
groupName?: String;
|
|
887
895
|
/**
|
|
888
|
-
* The prefix of the stream name of the
|
|
896
|
+
* The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
|
|
889
897
|
*/
|
|
890
898
|
streamName?: String;
|
|
891
899
|
}
|
|
@@ -978,7 +986,7 @@ declare namespace CodeBuild {
|
|
|
978
986
|
*/
|
|
979
987
|
secondarySources?: ProjectSources;
|
|
980
988
|
/**
|
|
981
|
-
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For
|
|
989
|
+
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
982
990
|
*/
|
|
983
991
|
sourceVersion?: String;
|
|
984
992
|
/**
|
|
@@ -1002,11 +1010,11 @@ declare namespace CodeBuild {
|
|
|
1002
1010
|
*/
|
|
1003
1011
|
environment: ProjectEnvironment;
|
|
1004
1012
|
/**
|
|
1005
|
-
* The ARN of the
|
|
1013
|
+
* The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
|
|
1006
1014
|
*/
|
|
1007
1015
|
serviceRole: NonEmptyString;
|
|
1008
1016
|
/**
|
|
1009
|
-
* How long, in minutes, from 5 to 480 (8 hours), for
|
|
1017
|
+
* How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
|
|
1010
1018
|
*/
|
|
1011
1019
|
timeoutInMinutes?: TimeOut;
|
|
1012
1020
|
/**
|
|
@@ -1014,15 +1022,15 @@ declare namespace CodeBuild {
|
|
|
1014
1022
|
*/
|
|
1015
1023
|
queuedTimeoutInMinutes?: TimeOut;
|
|
1016
1024
|
/**
|
|
1017
|
-
* The
|
|
1025
|
+
* The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
1018
1026
|
*/
|
|
1019
1027
|
encryptionKey?: NonEmptyString;
|
|
1020
1028
|
/**
|
|
1021
|
-
* A list of tag key and value pairs associated with this build project. These tags are available for use by
|
|
1029
|
+
* A list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
|
|
1022
1030
|
*/
|
|
1023
1031
|
tags?: TagList;
|
|
1024
1032
|
/**
|
|
1025
|
-
* VpcConfig enables
|
|
1033
|
+
* VpcConfig enables CodeBuild to access resources in an Amazon VPC.
|
|
1026
1034
|
*/
|
|
1027
1035
|
vpcConfig?: VpcConfig;
|
|
1028
1036
|
/**
|
|
@@ -1030,7 +1038,7 @@ declare namespace CodeBuild {
|
|
|
1030
1038
|
*/
|
|
1031
1039
|
badgeEnabled?: WrapperBoolean;
|
|
1032
1040
|
/**
|
|
1033
|
-
* Information about logs for the build project. These can be logs in
|
|
1041
|
+
* Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
|
|
1034
1042
|
*/
|
|
1035
1043
|
logsConfig?: LogsConfig;
|
|
1036
1044
|
/**
|
|
@@ -1066,7 +1074,7 @@ declare namespace CodeBuild {
|
|
|
1066
1074
|
*/
|
|
1067
1075
|
exportConfig: ReportExportConfig;
|
|
1068
1076
|
/**
|
|
1069
|
-
* A list of tag key and value pairs associated with this report group. These tags are available for use by
|
|
1077
|
+
* A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
|
|
1070
1078
|
*/
|
|
1071
1079
|
tags?: TagList;
|
|
1072
1080
|
}
|
|
@@ -1078,7 +1086,7 @@ declare namespace CodeBuild {
|
|
|
1078
1086
|
}
|
|
1079
1087
|
export interface CreateWebhookInput {
|
|
1080
1088
|
/**
|
|
1081
|
-
* The name of the
|
|
1089
|
+
* The name of the CodeBuild project.
|
|
1082
1090
|
*/
|
|
1083
1091
|
projectName: ProjectName;
|
|
1084
1092
|
/**
|
|
@@ -1096,7 +1104,7 @@ declare namespace CodeBuild {
|
|
|
1096
1104
|
}
|
|
1097
1105
|
export interface CreateWebhookOutput {
|
|
1098
1106
|
/**
|
|
1099
|
-
* Information about a webhook that connects repository events to a build project in
|
|
1107
|
+
* Information about a webhook that connects repository events to a build project in CodeBuild.
|
|
1100
1108
|
*/
|
|
1101
1109
|
webhook?: Webhook;
|
|
1102
1110
|
}
|
|
@@ -1181,7 +1189,7 @@ declare namespace CodeBuild {
|
|
|
1181
1189
|
}
|
|
1182
1190
|
export interface DeleteWebhookInput {
|
|
1183
1191
|
/**
|
|
1184
|
-
* The name of the
|
|
1192
|
+
* The name of the CodeBuild project.
|
|
1185
1193
|
*/
|
|
1186
1194
|
projectName: ProjectName;
|
|
1187
1195
|
}
|
|
@@ -1299,11 +1307,11 @@ declare namespace CodeBuild {
|
|
|
1299
1307
|
*/
|
|
1300
1308
|
name: NonEmptyString;
|
|
1301
1309
|
/**
|
|
1302
|
-
* The value of the environment variable. We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially
|
|
1310
|
+
* The value of the environment variable. We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
|
|
1303
1311
|
*/
|
|
1304
1312
|
value: String;
|
|
1305
1313
|
/**
|
|
1306
|
-
* The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in
|
|
1314
|
+
* The type of environment variable. Valid values include: PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide. PLAINTEXT: An environment variable in plain text format. This is the default value. SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.
|
|
1307
1315
|
*/
|
|
1308
1316
|
type?: EnvironmentVariableType;
|
|
1309
1317
|
}
|
|
@@ -1362,7 +1370,7 @@ declare namespace CodeBuild {
|
|
|
1362
1370
|
export type GitCloneDepth = number;
|
|
1363
1371
|
export interface GitSubmodulesConfig {
|
|
1364
1372
|
/**
|
|
1365
|
-
* Set to true to fetch Git submodules for your
|
|
1373
|
+
* Set to true to fetch Git submodules for your CodeBuild build project.
|
|
1366
1374
|
*/
|
|
1367
1375
|
fetchSubmodules: WrapperBoolean;
|
|
1368
1376
|
}
|
|
@@ -1383,7 +1391,7 @@ declare namespace CodeBuild {
|
|
|
1383
1391
|
*/
|
|
1384
1392
|
serverType: ServerType;
|
|
1385
1393
|
/**
|
|
1386
|
-
* The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the
|
|
1394
|
+
* The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.
|
|
1387
1395
|
*/
|
|
1388
1396
|
authType: AuthType;
|
|
1389
1397
|
/**
|
|
@@ -1399,7 +1407,7 @@ declare namespace CodeBuild {
|
|
|
1399
1407
|
}
|
|
1400
1408
|
export interface InvalidateProjectCacheInput {
|
|
1401
1409
|
/**
|
|
1402
|
-
* The name of the
|
|
1410
|
+
* The name of the CodeBuild build project that the cache is reset for.
|
|
1403
1411
|
*/
|
|
1404
1412
|
projectName: NonEmptyString;
|
|
1405
1413
|
}
|
|
@@ -1469,7 +1477,7 @@ declare namespace CodeBuild {
|
|
|
1469
1477
|
}
|
|
1470
1478
|
export interface ListBuildsForProjectInput {
|
|
1471
1479
|
/**
|
|
1472
|
-
* The name of the
|
|
1480
|
+
* The name of the CodeBuild project.
|
|
1473
1481
|
*/
|
|
1474
1482
|
projectName: NonEmptyString;
|
|
1475
1483
|
/**
|
|
@@ -1515,7 +1523,7 @@ declare namespace CodeBuild {
|
|
|
1515
1523
|
}
|
|
1516
1524
|
export interface ListCuratedEnvironmentImagesOutput {
|
|
1517
1525
|
/**
|
|
1518
|
-
* Information about supported platforms for Docker images that are managed by
|
|
1526
|
+
* Information about supported platforms for Docker images that are managed by CodeBuild.
|
|
1519
1527
|
*/
|
|
1520
1528
|
platforms?: EnvironmentPlatforms;
|
|
1521
1529
|
}
|
|
@@ -1567,7 +1575,7 @@ declare namespace CodeBuild {
|
|
|
1567
1575
|
*/
|
|
1568
1576
|
nextToken?: String;
|
|
1569
1577
|
/**
|
|
1570
|
-
* The list of ARNs for the report groups in the current
|
|
1578
|
+
* The list of ARNs for the report groups in the current Amazon Web Services account.
|
|
1571
1579
|
*/
|
|
1572
1580
|
reportGroups?: ReportGroupArns;
|
|
1573
1581
|
}
|
|
@@ -1627,13 +1635,13 @@ declare namespace CodeBuild {
|
|
|
1627
1635
|
*/
|
|
1628
1636
|
nextToken?: String;
|
|
1629
1637
|
/**
|
|
1630
|
-
* The list of returned ARNs for the reports in the current
|
|
1638
|
+
* The list of returned ARNs for the reports in the current Amazon Web Services account.
|
|
1631
1639
|
*/
|
|
1632
1640
|
reports?: ReportArns;
|
|
1633
1641
|
}
|
|
1634
1642
|
export interface ListSharedProjectsInput {
|
|
1635
1643
|
/**
|
|
1636
|
-
* The criterion to be used to list build projects shared with the current
|
|
1644
|
+
* The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared project was last changed.
|
|
1637
1645
|
*/
|
|
1638
1646
|
sortBy?: SharedResourceSortByType;
|
|
1639
1647
|
/**
|
|
@@ -1655,7 +1663,7 @@ declare namespace CodeBuild {
|
|
|
1655
1663
|
*/
|
|
1656
1664
|
nextToken?: String;
|
|
1657
1665
|
/**
|
|
1658
|
-
* The list of ARNs for the build projects shared with the current
|
|
1666
|
+
* The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
|
|
1659
1667
|
*/
|
|
1660
1668
|
projects?: ProjectArns;
|
|
1661
1669
|
}
|
|
@@ -1665,7 +1673,7 @@ declare namespace CodeBuild {
|
|
|
1665
1673
|
*/
|
|
1666
1674
|
sortOrder?: SortOrderType;
|
|
1667
1675
|
/**
|
|
1668
|
-
* The criterion to be used to list report groups shared with the current
|
|
1676
|
+
* The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared report group was last changed.
|
|
1669
1677
|
*/
|
|
1670
1678
|
sortBy?: SharedResourceSortByType;
|
|
1671
1679
|
/**
|
|
@@ -1683,7 +1691,7 @@ declare namespace CodeBuild {
|
|
|
1683
1691
|
*/
|
|
1684
1692
|
nextToken?: String;
|
|
1685
1693
|
/**
|
|
1686
|
-
* The list of ARNs for the report groups shared with the current
|
|
1694
|
+
* The list of ARNs for the report groups shared with the current Amazon Web Services account or user.
|
|
1687
1695
|
*/
|
|
1688
1696
|
reportGroups?: ReportGroupArns;
|
|
1689
1697
|
}
|
|
@@ -1697,7 +1705,7 @@ declare namespace CodeBuild {
|
|
|
1697
1705
|
}
|
|
1698
1706
|
export interface LogsConfig {
|
|
1699
1707
|
/**
|
|
1700
|
-
* Information about
|
|
1708
|
+
* Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
|
|
1701
1709
|
*/
|
|
1702
1710
|
cloudWatchLogs?: CloudWatchLogsConfig;
|
|
1703
1711
|
/**
|
|
@@ -1708,15 +1716,15 @@ declare namespace CodeBuild {
|
|
|
1708
1716
|
export type LogsConfigStatusType = "ENABLED"|"DISABLED"|string;
|
|
1709
1717
|
export interface LogsLocation {
|
|
1710
1718
|
/**
|
|
1711
|
-
* The name of the
|
|
1719
|
+
* The name of the CloudWatch Logs group for the build logs.
|
|
1712
1720
|
*/
|
|
1713
1721
|
groupName?: String;
|
|
1714
1722
|
/**
|
|
1715
|
-
* The name of the
|
|
1723
|
+
* The name of the CloudWatch Logs stream for the build logs.
|
|
1716
1724
|
*/
|
|
1717
1725
|
streamName?: String;
|
|
1718
1726
|
/**
|
|
1719
|
-
* The URL to an individual build log in
|
|
1727
|
+
* The URL to an individual build log in CloudWatch Logs.
|
|
1720
1728
|
*/
|
|
1721
1729
|
deepLink?: String;
|
|
1722
1730
|
/**
|
|
@@ -1724,7 +1732,7 @@ declare namespace CodeBuild {
|
|
|
1724
1732
|
*/
|
|
1725
1733
|
s3DeepLink?: String;
|
|
1726
1734
|
/**
|
|
1727
|
-
* The ARN of
|
|
1735
|
+
* The ARN of CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For more information, see Resources Defined by CloudWatch Logs.
|
|
1728
1736
|
*/
|
|
1729
1737
|
cloudWatchLogsArn?: String;
|
|
1730
1738
|
/**
|
|
@@ -1732,7 +1740,7 @@ declare namespace CodeBuild {
|
|
|
1732
1740
|
*/
|
|
1733
1741
|
s3LogsArn?: String;
|
|
1734
1742
|
/**
|
|
1735
|
-
* Information about
|
|
1743
|
+
* Information about CloudWatch Logs for a build project.
|
|
1736
1744
|
*/
|
|
1737
1745
|
cloudWatchLogs?: CloudWatchLogsConfig;
|
|
1738
1746
|
/**
|
|
@@ -1788,7 +1796,7 @@ declare namespace CodeBuild {
|
|
|
1788
1796
|
*/
|
|
1789
1797
|
secondarySources?: ProjectSources;
|
|
1790
1798
|
/**
|
|
1791
|
-
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For
|
|
1799
|
+
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
1792
1800
|
*/
|
|
1793
1801
|
sourceVersion?: String;
|
|
1794
1802
|
/**
|
|
@@ -1812,11 +1820,11 @@ declare namespace CodeBuild {
|
|
|
1812
1820
|
*/
|
|
1813
1821
|
environment?: ProjectEnvironment;
|
|
1814
1822
|
/**
|
|
1815
|
-
* The ARN of the
|
|
1823
|
+
* The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
|
|
1816
1824
|
*/
|
|
1817
1825
|
serviceRole?: NonEmptyString;
|
|
1818
1826
|
/**
|
|
1819
|
-
* How long, in minutes, from 5 to 480 (8 hours), for
|
|
1827
|
+
* How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
|
|
1820
1828
|
*/
|
|
1821
1829
|
timeoutInMinutes?: TimeOut;
|
|
1822
1830
|
/**
|
|
@@ -1824,11 +1832,11 @@ declare namespace CodeBuild {
|
|
|
1824
1832
|
*/
|
|
1825
1833
|
queuedTimeoutInMinutes?: TimeOut;
|
|
1826
1834
|
/**
|
|
1827
|
-
* The
|
|
1835
|
+
* The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
|
|
1828
1836
|
*/
|
|
1829
1837
|
encryptionKey?: NonEmptyString;
|
|
1830
1838
|
/**
|
|
1831
|
-
* A list of tag key and value pairs associated with this build project. These tags are available for use by
|
|
1839
|
+
* A list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
|
|
1832
1840
|
*/
|
|
1833
1841
|
tags?: TagList;
|
|
1834
1842
|
/**
|
|
@@ -1840,11 +1848,11 @@ declare namespace CodeBuild {
|
|
|
1840
1848
|
*/
|
|
1841
1849
|
lastModified?: Timestamp;
|
|
1842
1850
|
/**
|
|
1843
|
-
* Information about a webhook that connects repository events to a build project in
|
|
1851
|
+
* Information about a webhook that connects repository events to a build project in CodeBuild.
|
|
1844
1852
|
*/
|
|
1845
1853
|
webhook?: Webhook;
|
|
1846
1854
|
/**
|
|
1847
|
-
* Information about the VPC configuration that
|
|
1855
|
+
* Information about the VPC configuration that CodeBuild accesses.
|
|
1848
1856
|
*/
|
|
1849
1857
|
vpcConfig?: VpcConfig;
|
|
1850
1858
|
/**
|
|
@@ -1852,7 +1860,7 @@ declare namespace CodeBuild {
|
|
|
1852
1860
|
*/
|
|
1853
1861
|
badge?: ProjectBadge;
|
|
1854
1862
|
/**
|
|
1855
|
-
* Information about logs for the build project. A project can create logs in
|
|
1863
|
+
* Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
|
|
1856
1864
|
*/
|
|
1857
1865
|
logsConfig?: LogsConfig;
|
|
1858
1866
|
/**
|
|
@@ -1867,31 +1875,40 @@ declare namespace CodeBuild {
|
|
|
1867
1875
|
* The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
|
|
1868
1876
|
*/
|
|
1869
1877
|
concurrentBuildLimit?: WrapperInt;
|
|
1878
|
+
projectVisibility?: ProjectVisibilityType;
|
|
1879
|
+
/**
|
|
1880
|
+
* Contains the project identifier used with the public build APIs.
|
|
1881
|
+
*/
|
|
1882
|
+
publicProjectAlias?: NonEmptyString;
|
|
1883
|
+
/**
|
|
1884
|
+
* The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
|
|
1885
|
+
*/
|
|
1886
|
+
resourceAccessRole?: NonEmptyString;
|
|
1870
1887
|
}
|
|
1871
1888
|
export type ProjectArns = NonEmptyString[];
|
|
1872
1889
|
export interface ProjectArtifacts {
|
|
1873
1890
|
/**
|
|
1874
|
-
* The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through
|
|
1891
|
+
* The type of build output artifact. Valid values include: CODEPIPELINE: The build project has build output generated through CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts. NO_ARTIFACTS: The build project does not produce any build output. S3: The build project stores build output in Amazon S3.
|
|
1875
1892
|
*/
|
|
1876
1893
|
type: ArtifactsType;
|
|
1877
1894
|
/**
|
|
1878
|
-
* Information about the build output artifact location: If type is set to CODEPIPELINE,
|
|
1895
|
+
* Information about the build output artifact location: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output bucket.
|
|
1879
1896
|
*/
|
|
1880
1897
|
location?: String;
|
|
1881
1898
|
/**
|
|
1882
|
-
* Along with namespaceType and name, the pattern that
|
|
1899
|
+
* Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used. For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
|
|
1883
1900
|
*/
|
|
1884
1901
|
path?: String;
|
|
1885
1902
|
/**
|
|
1886
|
-
* Along with path and name, the pattern that
|
|
1903
|
+
* Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: BUILD_ID: Include the build ID in the location of the build output artifact. NONE: Do not include the build ID. This is the default if namespaceType is not specified. For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
|
|
1887
1904
|
*/
|
|
1888
1905
|
namespaceType?: ArtifactNamespace;
|
|
1889
1906
|
/**
|
|
1890
|
-
* Along with path and namespaceType, the pattern that
|
|
1907
|
+
* Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket. For example: If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip. If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket. If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.
|
|
1891
1908
|
*/
|
|
1892
1909
|
name?: String;
|
|
1893
1910
|
/**
|
|
1894
|
-
* The type of build output artifact to create: If type is set to CODEPIPELINE,
|
|
1911
|
+
* The type of build output artifact to create: If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild. If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced. If type is set to S3, valid values include: NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified. ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
|
|
1895
1912
|
*/
|
|
1896
1913
|
packaging?: ArtifactPackaging;
|
|
1897
1914
|
/**
|
|
@@ -1955,15 +1972,15 @@ declare namespace CodeBuild {
|
|
|
1955
1972
|
export type ProjectDescription = string;
|
|
1956
1973
|
export interface ProjectEnvironment {
|
|
1957
1974
|
/**
|
|
1958
|
-
* The type of build environment to use for related builds. The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
|
|
1975
|
+
* The type of build environment to use for related builds. The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland). For more information, see Build environment compute types in the CodeBuild user guide.
|
|
1959
1976
|
*/
|
|
1960
1977
|
type: EnvironmentType;
|
|
1961
1978
|
/**
|
|
1962
|
-
* The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats: For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0. For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
|
|
1979
|
+
* The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats: For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0. For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
|
|
1963
1980
|
*/
|
|
1964
1981
|
image: NonEmptyString;
|
|
1965
1982
|
/**
|
|
1966
|
-
* Information about the compute resources the build project uses. Available values include: BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use BUILD_GENERAL1_LARGE: For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds. For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
|
|
1983
|
+
* Information about the compute resources the build project uses. Available values include: BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use BUILD_GENERAL1_LARGE: For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds. For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see Build Environment Compute Types in the CodeBuild User Guide.
|
|
1967
1984
|
*/
|
|
1968
1985
|
computeType: ComputeType;
|
|
1969
1986
|
/**
|
|
@@ -1975,7 +1992,7 @@ declare namespace CodeBuild {
|
|
|
1975
1992
|
*/
|
|
1976
1993
|
privilegedMode?: WrapperBoolean;
|
|
1977
1994
|
/**
|
|
1978
|
-
* The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the
|
|
1995
|
+
* The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.
|
|
1979
1996
|
*/
|
|
1980
1997
|
certificate?: String;
|
|
1981
1998
|
/**
|
|
@@ -1983,7 +2000,7 @@ declare namespace CodeBuild {
|
|
|
1983
2000
|
*/
|
|
1984
2001
|
registryCredential?: RegistryCredential;
|
|
1985
2002
|
/**
|
|
1986
|
-
* The type of credentials
|
|
2003
|
+
* The type of credentials CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. SERVICE_ROLE specifies that CodeBuild uses your build project's service role. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
|
|
1987
2004
|
*/
|
|
1988
2005
|
imagePullCredentialsType?: ImagePullCredentialsType;
|
|
1989
2006
|
}
|
|
@@ -1993,7 +2010,7 @@ declare namespace CodeBuild {
|
|
|
1993
2010
|
*/
|
|
1994
2011
|
type?: FileSystemType;
|
|
1995
2012
|
/**
|
|
1996
|
-
* A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the
|
|
2013
|
+
* A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory. The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
|
|
1997
2014
|
*/
|
|
1998
2015
|
location?: String;
|
|
1999
2016
|
/**
|
|
@@ -2005,7 +2022,7 @@ declare namespace CodeBuild {
|
|
|
2005
2022
|
*/
|
|
2006
2023
|
identifier?: String;
|
|
2007
2024
|
/**
|
|
2008
|
-
* The mount options for a file system created by
|
|
2025
|
+
* The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
|
|
2009
2026
|
*/
|
|
2010
2027
|
mountOptions?: String;
|
|
2011
2028
|
}
|
|
@@ -2016,11 +2033,11 @@ declare namespace CodeBuild {
|
|
|
2016
2033
|
export type ProjectSortByType = "NAME"|"CREATED_TIME"|"LAST_MODIFIED_TIME"|string;
|
|
2017
2034
|
export interface ProjectSource {
|
|
2018
2035
|
/**
|
|
2019
|
-
* The type of repository that contains the source code to be built. Valid values include: BITBUCKET: The source code is in a Bitbucket repository. CODECOMMIT: The source code is in an
|
|
2036
|
+
* The type of repository that contains the source code to be built. Valid values include: BITBUCKET: The source code is in a Bitbucket repository. CODECOMMIT: The source code is in an CodeCommit repository. CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline. GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository. GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository. NO_SOURCE: The project does not have input source code. S3: The source code is in an Amazon S3 bucket.
|
|
2020
2037
|
*/
|
|
2021
2038
|
type: SourceType;
|
|
2022
2039
|
/**
|
|
2023
|
-
* Information about the location of the source code to be built. Valid values include: For source code settings that are specified in the source action of a pipeline in
|
|
2040
|
+
* Information about the location of the source code to be built. Valid values include: For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value. For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>). For source code in an Amazon S3 input bucket, one of the following. The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip). The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/). For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH. If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.
|
|
2024
2041
|
*/
|
|
2025
2042
|
location?: String;
|
|
2026
2043
|
/**
|
|
@@ -2032,15 +2049,15 @@ declare namespace CodeBuild {
|
|
|
2032
2049
|
*/
|
|
2033
2050
|
gitSubmodulesConfig?: GitSubmodulesConfig;
|
|
2034
2051
|
/**
|
|
2035
|
-
* The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same
|
|
2052
|
+
* The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
|
|
2036
2053
|
*/
|
|
2037
2054
|
buildspec?: String;
|
|
2038
2055
|
/**
|
|
2039
|
-
* Information about the authorization settings for
|
|
2056
|
+
* Information about the authorization settings for CodeBuild to access the source code to be built. This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
|
|
2040
2057
|
*/
|
|
2041
2058
|
auth?: SourceAuth;
|
|
2042
2059
|
/**
|
|
2043
|
-
* Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the
|
|
2060
|
+
* Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider.
|
|
2044
2061
|
*/
|
|
2045
2062
|
reportBuildStatus?: WrapperBoolean;
|
|
2046
2063
|
/**
|
|
@@ -2062,15 +2079,16 @@ declare namespace CodeBuild {
|
|
|
2062
2079
|
*/
|
|
2063
2080
|
sourceIdentifier: String;
|
|
2064
2081
|
/**
|
|
2065
|
-
* The source version for the corresponding source identifier. If specified, must be one of: For
|
|
2082
|
+
* The source version for the corresponding source identifier. If specified, must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
2066
2083
|
*/
|
|
2067
2084
|
sourceVersion: String;
|
|
2068
2085
|
}
|
|
2069
2086
|
export type ProjectSources = ProjectSource[];
|
|
2087
|
+
export type ProjectVisibilityType = "PUBLIC_READ"|"PRIVATE"|string;
|
|
2070
2088
|
export type Projects = Project[];
|
|
2071
2089
|
export interface PutResourcePolicyInput {
|
|
2072
2090
|
/**
|
|
2073
|
-
* A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the
|
|
2091
|
+
* A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.
|
|
2074
2092
|
*/
|
|
2075
2093
|
policy: NonEmptyString;
|
|
2076
2094
|
/**
|
|
@@ -2086,11 +2104,11 @@ declare namespace CodeBuild {
|
|
|
2086
2104
|
}
|
|
2087
2105
|
export interface RegistryCredential {
|
|
2088
2106
|
/**
|
|
2089
|
-
* The Amazon Resource Name (ARN) or name of credentials created using
|
|
2107
|
+
* The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
|
|
2090
2108
|
*/
|
|
2091
2109
|
credential: NonEmptyString;
|
|
2092
2110
|
/**
|
|
2093
|
-
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for
|
|
2111
|
+
* The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
|
|
2094
2112
|
*/
|
|
2095
2113
|
credentialProvider: CredentialProviderType;
|
|
2096
2114
|
}
|
|
@@ -2189,7 +2207,7 @@ declare namespace CodeBuild {
|
|
|
2189
2207
|
*/
|
|
2190
2208
|
lastModified?: Timestamp;
|
|
2191
2209
|
/**
|
|
2192
|
-
* A list of tag key and value pairs associated with this report group. These tags are available for use by
|
|
2210
|
+
* A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
|
|
2193
2211
|
*/
|
|
2194
2212
|
tags?: TagList;
|
|
2195
2213
|
/**
|
|
@@ -2254,7 +2272,7 @@ declare namespace CodeBuild {
|
|
|
2254
2272
|
*/
|
|
2255
2273
|
id?: NonEmptyString;
|
|
2256
2274
|
/**
|
|
2257
|
-
* A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter,
|
|
2275
|
+
* A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
|
|
2258
2276
|
*/
|
|
2259
2277
|
idempotencyToken?: String;
|
|
2260
2278
|
/**
|
|
@@ -2272,7 +2290,7 @@ declare namespace CodeBuild {
|
|
|
2272
2290
|
*/
|
|
2273
2291
|
id?: NonEmptyString;
|
|
2274
2292
|
/**
|
|
2275
|
-
* A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter,
|
|
2293
|
+
* A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
|
|
2276
2294
|
*/
|
|
2277
2295
|
idempotencyToken?: String;
|
|
2278
2296
|
}
|
|
@@ -2300,7 +2318,7 @@ declare namespace CodeBuild {
|
|
|
2300
2318
|
*/
|
|
2301
2319
|
bucket?: NonEmptyString;
|
|
2302
2320
|
/**
|
|
2303
|
-
* The
|
|
2321
|
+
* The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
|
|
2304
2322
|
*/
|
|
2305
2323
|
bucketOwner?: String;
|
|
2306
2324
|
/**
|
|
@@ -2308,7 +2326,7 @@ declare namespace CodeBuild {
|
|
|
2308
2326
|
*/
|
|
2309
2327
|
path?: String;
|
|
2310
2328
|
/**
|
|
2311
|
-
* The type of build output artifact to create. Valid values include: NONE:
|
|
2329
|
+
* The type of build output artifact to create. Valid values include: NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
|
|
2312
2330
|
*/
|
|
2313
2331
|
packaging?: ReportPackagingType;
|
|
2314
2332
|
/**
|
|
@@ -2366,7 +2384,7 @@ declare namespace CodeBuild {
|
|
|
2366
2384
|
*/
|
|
2367
2385
|
secondarySourcesVersionOverride?: ProjectSecondarySourceVersions;
|
|
2368
2386
|
/**
|
|
2369
|
-
* The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
|
|
2387
|
+
* The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Amazon S3 The version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
2370
2388
|
*/
|
|
2371
2389
|
sourceVersion?: String;
|
|
2372
2390
|
/**
|
|
@@ -2402,7 +2420,7 @@ declare namespace CodeBuild {
|
|
|
2402
2420
|
*/
|
|
2403
2421
|
gitSubmodulesConfigOverride?: GitSubmodulesConfig;
|
|
2404
2422
|
/**
|
|
2405
|
-
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same
|
|
2423
|
+
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
|
|
2406
2424
|
*/
|
|
2407
2425
|
buildspecOverride?: String;
|
|
2408
2426
|
/**
|
|
@@ -2450,11 +2468,11 @@ declare namespace CodeBuild {
|
|
|
2450
2468
|
*/
|
|
2451
2469
|
queuedTimeoutInMinutesOverride?: TimeOut;
|
|
2452
2470
|
/**
|
|
2453
|
-
* The
|
|
2471
|
+
* The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
2454
2472
|
*/
|
|
2455
2473
|
encryptionKeyOverride?: NonEmptyString;
|
|
2456
2474
|
/**
|
|
2457
|
-
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter,
|
|
2475
|
+
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
|
|
2458
2476
|
*/
|
|
2459
2477
|
idempotencyToken?: String;
|
|
2460
2478
|
/**
|
|
@@ -2466,7 +2484,7 @@ declare namespace CodeBuild {
|
|
|
2466
2484
|
*/
|
|
2467
2485
|
registryCredentialOverride?: RegistryCredential;
|
|
2468
2486
|
/**
|
|
2469
|
-
* The type of credentials
|
|
2487
|
+
* The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICE_ROLE Specifies that CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
|
|
2470
2488
|
*/
|
|
2471
2489
|
imagePullCredentialsTypeOverride?: ImagePullCredentialsType;
|
|
2472
2490
|
/**
|
|
@@ -2486,7 +2504,7 @@ declare namespace CodeBuild {
|
|
|
2486
2504
|
}
|
|
2487
2505
|
export interface StartBuildInput {
|
|
2488
2506
|
/**
|
|
2489
|
-
* The name of the
|
|
2507
|
+
* The name of the CodeBuild build project to start running a build.
|
|
2490
2508
|
*/
|
|
2491
2509
|
projectName: NonEmptyString;
|
|
2492
2510
|
/**
|
|
@@ -2498,7 +2516,7 @@ declare namespace CodeBuild {
|
|
|
2498
2516
|
*/
|
|
2499
2517
|
secondarySourcesVersionOverride?: ProjectSecondarySourceVersions;
|
|
2500
2518
|
/**
|
|
2501
|
-
* The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
|
|
2519
|
+
* The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Amazon S3 The version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
2502
2520
|
*/
|
|
2503
2521
|
sourceVersion?: String;
|
|
2504
2522
|
/**
|
|
@@ -2530,11 +2548,11 @@ declare namespace CodeBuild {
|
|
|
2530
2548
|
*/
|
|
2531
2549
|
gitCloneDepthOverride?: GitCloneDepth;
|
|
2532
2550
|
/**
|
|
2533
|
-
* Information about the Git submodules configuration for this build of an
|
|
2551
|
+
* Information about the Git submodules configuration for this build of an CodeBuild build project.
|
|
2534
2552
|
*/
|
|
2535
2553
|
gitSubmodulesConfigOverride?: GitSubmodulesConfig;
|
|
2536
2554
|
/**
|
|
2537
|
-
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same
|
|
2555
|
+
* A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
|
|
2538
2556
|
*/
|
|
2539
2557
|
buildspecOverride?: String;
|
|
2540
2558
|
/**
|
|
@@ -2542,7 +2560,7 @@ declare namespace CodeBuild {
|
|
|
2542
2560
|
*/
|
|
2543
2561
|
insecureSslOverride?: WrapperBoolean;
|
|
2544
2562
|
/**
|
|
2545
|
-
* Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the
|
|
2563
|
+
* Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider.
|
|
2546
2564
|
*/
|
|
2547
2565
|
reportBuildStatusOverride?: WrapperBoolean;
|
|
2548
2566
|
/**
|
|
@@ -2586,11 +2604,11 @@ declare namespace CodeBuild {
|
|
|
2586
2604
|
*/
|
|
2587
2605
|
queuedTimeoutInMinutesOverride?: TimeOut;
|
|
2588
2606
|
/**
|
|
2589
|
-
* The
|
|
2607
|
+
* The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
2590
2608
|
*/
|
|
2591
2609
|
encryptionKeyOverride?: NonEmptyString;
|
|
2592
2610
|
/**
|
|
2593
|
-
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter,
|
|
2611
|
+
* A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
|
|
2594
2612
|
*/
|
|
2595
2613
|
idempotencyToken?: String;
|
|
2596
2614
|
/**
|
|
@@ -2602,7 +2620,7 @@ declare namespace CodeBuild {
|
|
|
2602
2620
|
*/
|
|
2603
2621
|
registryCredentialOverride?: RegistryCredential;
|
|
2604
2622
|
/**
|
|
2605
|
-
* The type of credentials
|
|
2623
|
+
* The type of credentials CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICE_ROLE Specifies that CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
|
|
2606
2624
|
*/
|
|
2607
2625
|
imagePullCredentialsTypeOverride?: ImagePullCredentialsType;
|
|
2608
2626
|
/**
|
|
@@ -2730,7 +2748,7 @@ declare namespace CodeBuild {
|
|
|
2730
2748
|
*/
|
|
2731
2749
|
secondarySources?: ProjectSources;
|
|
2732
2750
|
/**
|
|
2733
|
-
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For
|
|
2751
|
+
* A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
|
|
2734
2752
|
*/
|
|
2735
2753
|
sourceVersion?: String;
|
|
2736
2754
|
/**
|
|
@@ -2754,11 +2772,11 @@ declare namespace CodeBuild {
|
|
|
2754
2772
|
*/
|
|
2755
2773
|
environment?: ProjectEnvironment;
|
|
2756
2774
|
/**
|
|
2757
|
-
* The replacement ARN of the
|
|
2775
|
+
* The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
|
|
2758
2776
|
*/
|
|
2759
2777
|
serviceRole?: NonEmptyString;
|
|
2760
2778
|
/**
|
|
2761
|
-
* The replacement value in minutes, from 5 to 480 (8 hours), for
|
|
2779
|
+
* The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
|
|
2762
2780
|
*/
|
|
2763
2781
|
timeoutInMinutes?: TimeOut;
|
|
2764
2782
|
/**
|
|
@@ -2766,15 +2784,15 @@ declare namespace CodeBuild {
|
|
|
2766
2784
|
*/
|
|
2767
2785
|
queuedTimeoutInMinutes?: TimeOut;
|
|
2768
2786
|
/**
|
|
2769
|
-
* The
|
|
2787
|
+
* The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
|
|
2770
2788
|
*/
|
|
2771
2789
|
encryptionKey?: NonEmptyString;
|
|
2772
2790
|
/**
|
|
2773
|
-
* An updated list of tag key and value pairs associated with this build project. These tags are available for use by
|
|
2791
|
+
* An updated list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
|
|
2774
2792
|
*/
|
|
2775
2793
|
tags?: TagList;
|
|
2776
2794
|
/**
|
|
2777
|
-
* VpcConfig enables
|
|
2795
|
+
* VpcConfig enables CodeBuild to access resources in an Amazon VPC.
|
|
2778
2796
|
*/
|
|
2779
2797
|
vpcConfig?: VpcConfig;
|
|
2780
2798
|
/**
|
|
@@ -2782,7 +2800,7 @@ declare namespace CodeBuild {
|
|
|
2782
2800
|
*/
|
|
2783
2801
|
badgeEnabled?: WrapperBoolean;
|
|
2784
2802
|
/**
|
|
2785
|
-
* Information about logs for the build project. A project can create logs in
|
|
2803
|
+
* Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
|
|
2786
2804
|
*/
|
|
2787
2805
|
logsConfig?: LogsConfig;
|
|
2788
2806
|
/**
|
|
@@ -2801,6 +2819,28 @@ declare namespace CodeBuild {
|
|
|
2801
2819
|
*/
|
|
2802
2820
|
project?: Project;
|
|
2803
2821
|
}
|
|
2822
|
+
export interface UpdateProjectVisibilityInput {
|
|
2823
|
+
/**
|
|
2824
|
+
* The Amazon Resource Name (ARN) of the build project.
|
|
2825
|
+
*/
|
|
2826
|
+
projectArn: NonEmptyString;
|
|
2827
|
+
projectVisibility: ProjectVisibilityType;
|
|
2828
|
+
/**
|
|
2829
|
+
* The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
|
|
2830
|
+
*/
|
|
2831
|
+
resourceAccessRole?: NonEmptyString;
|
|
2832
|
+
}
|
|
2833
|
+
export interface UpdateProjectVisibilityOutput {
|
|
2834
|
+
/**
|
|
2835
|
+
* The Amazon Resource Name (ARN) of the build project.
|
|
2836
|
+
*/
|
|
2837
|
+
projectArn?: NonEmptyString;
|
|
2838
|
+
/**
|
|
2839
|
+
* Contains the project identifier used with the public build APIs.
|
|
2840
|
+
*/
|
|
2841
|
+
publicProjectAlias?: NonEmptyString;
|
|
2842
|
+
projectVisibility?: ProjectVisibilityType;
|
|
2843
|
+
}
|
|
2804
2844
|
export interface UpdateReportGroupInput {
|
|
2805
2845
|
/**
|
|
2806
2846
|
* The ARN of the report group to update.
|
|
@@ -2811,7 +2851,7 @@ declare namespace CodeBuild {
|
|
|
2811
2851
|
*/
|
|
2812
2852
|
exportConfig?: ReportExportConfig;
|
|
2813
2853
|
/**
|
|
2814
|
-
* An updated list of tag key and value pairs associated with this report group. These tags are available for use by
|
|
2854
|
+
* An updated list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
|
|
2815
2855
|
*/
|
|
2816
2856
|
tags?: TagList;
|
|
2817
2857
|
}
|
|
@@ -2823,7 +2863,7 @@ declare namespace CodeBuild {
|
|
|
2823
2863
|
}
|
|
2824
2864
|
export interface UpdateWebhookInput {
|
|
2825
2865
|
/**
|
|
2826
|
-
* The name of the
|
|
2866
|
+
* The name of the CodeBuild project.
|
|
2827
2867
|
*/
|
|
2828
2868
|
projectName: ProjectName;
|
|
2829
2869
|
/**
|
|
@@ -2845,7 +2885,7 @@ declare namespace CodeBuild {
|
|
|
2845
2885
|
}
|
|
2846
2886
|
export interface UpdateWebhookOutput {
|
|
2847
2887
|
/**
|
|
2848
|
-
* Information about a repository's webhook that is associated with a project in
|
|
2888
|
+
* Information about a repository's webhook that is associated with a project in CodeBuild.
|
|
2849
2889
|
*/
|
|
2850
2890
|
webhook?: Webhook;
|
|
2851
2891
|
}
|
|
@@ -2870,7 +2910,7 @@ declare namespace CodeBuild {
|
|
|
2870
2910
|
*/
|
|
2871
2911
|
url?: NonEmptyString;
|
|
2872
2912
|
/**
|
|
2873
|
-
* The
|
|
2913
|
+
* The CodeBuild endpoint where webhook events are sent.
|
|
2874
2914
|
*/
|
|
2875
2915
|
payloadUrl?: NonEmptyString;
|
|
2876
2916
|
/**
|