aws-sdk-codebuild 1.22.0 → 1.23.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.
@@ -172,7 +172,7 @@ module Aws::CodeBuild
172
172
  # @return [String]
173
173
  #
174
174
  # @!attribute [rw] phases
175
- # Information about all previous build phases that are completed and
175
+ # Information about all previous build phases that are complete and
176
176
  # information about any current build phase that is not yet complete.
177
177
  # @return [Array<Types::BuildPhase>]
178
178
  #
@@ -193,18 +193,18 @@ module Aws::CodeBuild
193
193
  # * For GitHub: the commit ID, pull request ID, branch name, or tag
194
194
  # name that corresponds to the version of the source code you want
195
195
  # to build. If a pull request ID is specified, it must use the
196
- # format `pr/pull-request-ID` (for example `pr/25`). If a branch
197
- # name is specified, the branch's HEAD commit ID will be used. If
198
- # not specified, the default branch's HEAD commit ID will be used.
196
+ # format `pr/pull-request-ID` (for example, `pr/25`). If a branch
197
+ # name is specified, the branch's HEAD commit ID is used. If not
198
+ # specified, the default branch's HEAD commit ID is used.
199
199
  #
200
200
  # * For Bitbucket: the commit ID, branch name, or tag name that
201
201
  # corresponds to the version of the source code you want to build.
202
- # If a branch name is specified, the branch's HEAD commit ID will
203
- # be used. If not specified, the default branch's HEAD commit ID
204
- # will be used.
202
+ # If a branch name is specified, the branch's HEAD commit ID is
203
+ # used. If not specified, the default branch's HEAD commit ID is
204
+ # used.
205
205
  #
206
206
  # * For Amazon Simple Storage Service (Amazon S3): the version ID of
207
- # the object representing the build input ZIP file to use.
207
+ # the object that represents the build input ZIP file to use.
208
208
  # @return [Array<Types::ProjectSourceVersion>]
209
209
  #
210
210
  # @!attribute [rw] artifacts
@@ -236,8 +236,13 @@ module Aws::CodeBuild
236
236
  # this build if it does not get marked as completed.
237
237
  # @return [Integer]
238
238
  #
239
+ # @!attribute [rw] queued_timeout_in_minutes
240
+ # The number of minutes a build is allowed to be queued before it
241
+ # times out.
242
+ # @return [Integer]
243
+ #
239
244
  # @!attribute [rw] build_complete
240
- # Whether the build has finished. True if completed; otherwise, false.
245
+ # Whether the build is complete. True if complete; otherwise, false.
241
246
  # @return [Boolean]
242
247
  #
243
248
  # @!attribute [rw] initiator
@@ -247,7 +252,7 @@ module Aws::CodeBuild
247
252
  # example, `codepipeline/my-demo-pipeline`).
248
253
  #
249
254
  # * If an AWS Identity and Access Management (IAM) user started the
250
- # build, the user's name (for example `MyUserName`).
255
+ # build, the user's name (for example, `MyUserName`).
251
256
  #
252
257
  # * If the Jenkins plugin for AWS CodeBuild started the build, the
253
258
  # string `CodeBuild-Jenkins-Plugin`.
@@ -269,8 +274,8 @@ module Aws::CodeBuild
269
274
  # The AWS Key Management Service (AWS KMS) customer master key (CMK)
270
275
  # to be used for encrypting the build output artifacts.
271
276
  #
272
- # This is expressed either as the CMK's Amazon Resource Name (ARN)
273
- # or, if specified, the CMK's alias (using the format
277
+ # This is expressed either as the Amazon Resource Name (ARN) of the
278
+ # CMK or, if specified, the CMK's alias (using the format
274
279
  # `alias/alias-name `).
275
280
  # @return [String]
276
281
  #
@@ -297,6 +302,7 @@ module Aws::CodeBuild
297
302
  :service_role,
298
303
  :logs,
299
304
  :timeout_in_minutes,
305
+ :queued_timeout_in_minutes,
300
306
  :build_complete,
301
307
  :initiator,
302
308
  :vpc_config,
@@ -314,8 +320,8 @@ module Aws::CodeBuild
314
320
  # @!attribute [rw] sha256sum
315
321
  # The SHA-256 hash of the build artifact.
316
322
  #
317
- # You can use this hash along with a checksum tool to confirm both
318
- # file integrity and authenticity.
323
+ # You can use this hash along with a checksum tool to confirm file
324
+ # integrity and authenticity.
319
325
  #
320
326
  # <note markdown="1"> This value is available only if the build project's `packaging`
321
327
  # value is set to `ZIP`.
@@ -326,8 +332,8 @@ module Aws::CodeBuild
326
332
  # @!attribute [rw] md5sum
327
333
  # The MD5 hash of the build artifact.
328
334
  #
329
- # You can use this hash along with a checksum tool to confirm both
330
- # file integrity and authenticity.
335
+ # You can use this hash along with a checksum tool to confirm file
336
+ # integrity and authenticity.
331
337
  #
332
338
  # <note markdown="1"> This value is available only if the build project's `packaging`
333
339
  # value is set to `ZIP`.
@@ -336,8 +342,8 @@ module Aws::CodeBuild
336
342
  # @return [String]
337
343
  #
338
344
  # @!attribute [rw] override_artifact_name
339
- # If this flag is set, a name specified in the buildspec file
340
- # overrides the artifact name. The name specified in a buildspec file
345
+ # If this flag is set, a name specified in the build spec file
346
+ # overrides the artifact name. The name specified in a build spec file
341
347
  # is calculated at build time and uses the Shell Command Language. For
342
348
  # example, you can append a date and time to your artifact name so
343
349
  # that it is always unique.
@@ -410,6 +416,9 @@ module Aws::CodeBuild
410
416
  #
411
417
  # * `PROVISIONING`\: The build environment is being set up.
412
418
  #
419
+ # * `QUEUED`\: The build has been submitted and is queued behind other
420
+ # submitted builds.
421
+ #
413
422
  # * `SUBMITTED`\: The build has been submitted.
414
423
  #
415
424
  # * `UPLOAD_ARTIFACTS`\: Build output artifacts are being uploaded to
@@ -425,6 +434,9 @@ module Aws::CodeBuild
425
434
  #
426
435
  # * `IN_PROGRESS`\: The build phase is still in progress.
427
436
  #
437
+ # * `QUEUED`\: The build has been submitted and is queued behind other
438
+ # submitted builds.
439
+ #
428
440
  # * `STOPPED`\: The build phase stopped.
429
441
  #
430
442
  # * `SUCCEEDED`\: The build phase succeeded.
@@ -474,7 +486,7 @@ module Aws::CodeBuild
474
486
  # }
475
487
  #
476
488
  # @!attribute [rw] status
477
- # The current status of the Amazon CloudWatch Logs for a build
489
+ # The current status of the logs in Amazon CloudWatch Logs for a build
478
490
  # project. Valid values are:
479
491
  #
480
492
  # * `ENABLED`\: Amazon CloudWatch Logs are enabled for this build
@@ -485,8 +497,8 @@ module Aws::CodeBuild
485
497
  # @return [String]
486
498
  #
487
499
  # @!attribute [rw] group_name
488
- # The group name of the Amazon CloudWatch Logs. For more information,
489
- # see [Working with Log Groups and Log Streams][1]
500
+ # The group name of the logs in Amazon CloudWatch Logs. For more
501
+ # information, see [Working with Log Groups and Log Streams][1].
490
502
  #
491
503
  #
492
504
  #
@@ -495,7 +507,7 @@ module Aws::CodeBuild
495
507
  #
496
508
  # @!attribute [rw] stream_name
497
509
  # The prefix of the stream name of the Amazon CloudWatch Logs. For
498
- # more information, see [Working with Log Groups and Log Streams][1]
510
+ # more information, see [Working with Log Groups and Log Streams][1].
499
511
  #
500
512
  #
501
513
  #
@@ -589,6 +601,7 @@ module Aws::CodeBuild
589
601
  # },
590
602
  # service_role: "NonEmptyString", # required
591
603
  # timeout_in_minutes: 1,
604
+ # queued_timeout_in_minutes: 1,
592
605
  # encryption_key: "NonEmptyString",
593
606
  # tags: [
594
607
  # {
@@ -656,16 +669,22 @@ module Aws::CodeBuild
656
669
  #
657
670
  # @!attribute [rw] timeout_in_minutes
658
671
  # How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to
659
- # wait until timing out any build that has not been marked as
672
+ # wait before it times out any build that has not been marked as
660
673
  # completed. The default is 60 minutes.
661
674
  # @return [Integer]
662
675
  #
676
+ # @!attribute [rw] queued_timeout_in_minutes
677
+ # The number of minutes a build is allowed to be queued before it
678
+ # times out.
679
+ # @return [Integer]
680
+ #
663
681
  # @!attribute [rw] encryption_key
664
682
  # The AWS Key Management Service (AWS KMS) customer master key (CMK)
665
683
  # to be used for encrypting the build output artifacts.
666
684
  #
667
- # You can specify either the CMK's Amazon Resource Name (ARN) or, if
668
- # available, the CMK's alias (using the format `alias/alias-name `).
685
+ # You can specify either the Amazon Resource Name (ARN) of the CMK or,
686
+ # if available, the CMK's alias (using the format `alias/alias-name
687
+ # `).
669
688
  # @return [String]
670
689
  #
671
690
  # @!attribute [rw] tags
@@ -681,13 +700,14 @@ module Aws::CodeBuild
681
700
  # @return [Types::VpcConfig]
682
701
  #
683
702
  # @!attribute [rw] badge_enabled
684
- # Set this to true to generate a publicly-accessible URL for your
703
+ # Set this to true to generate a publicly accessible URL for your
685
704
  # project's build badge.
686
705
  # @return [Boolean]
687
706
  #
688
707
  # @!attribute [rw] logs_config
689
- # Information about logs for the build project. Logs can be Amazon
690
- # CloudWatch Logs, uploaded to a specified S3 bucket, or both.
708
+ # Information about logs for the build project. These can be logs in
709
+ # Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or
710
+ # both.
691
711
  # @return [Types::LogsConfig]
692
712
  #
693
713
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/CreateProjectInput AWS API Documentation
@@ -703,6 +723,7 @@ module Aws::CodeBuild
703
723
  :environment,
704
724
  :service_role,
705
725
  :timeout_in_minutes,
726
+ :queued_timeout_in_minutes,
706
727
  :encryption_key,
707
728
  :tags,
708
729
  :vpc_config,
@@ -735,11 +756,10 @@ module Aws::CodeBuild
735
756
  # @return [String]
736
757
  #
737
758
  # @!attribute [rw] branch_filter
738
- # A regular expression used to determine which branches in a
739
- # repository are built when a webhook is triggered. If the name of a
740
- # branch matches the regular expression, then it is built. If it
741
- # doesn't match, then it is not. If `branchFilter` is empty, then all
742
- # branches are built.
759
+ # A regular expression used to determine which repository branches are
760
+ # built when a webhook is triggered. If the name of a branch matches
761
+ # the regular expression, then it is built. If `branchFilter` is
762
+ # empty, then all branches are built.
743
763
  # @return [String]
744
764
  #
745
765
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/CreateWebhookInput AWS API Documentation
@@ -888,11 +908,10 @@ module Aws::CodeBuild
888
908
  # @!attribute [rw] value
889
909
  # The value of the environment variable.
890
910
  #
891
- # We strongly discourage using environment variables to store
911
+ # We strongly discourage the use of environment variables to store
892
912
  # sensitive values, especially AWS secret key IDs and secret access
893
- # keys. Environment variables can be displayed in plain text using
894
- # tools such as the AWS CodeBuild console and the AWS Command Line
895
- # Interface (AWS CLI).
913
+ # keys. Environment variables can be displayed in plain text using the
914
+ # AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).
896
915
  # @return [String]
897
916
  #
898
917
  # @!attribute [rw] type
@@ -921,8 +940,8 @@ module Aws::CodeBuild
921
940
  # }
922
941
  #
923
942
  # @!attribute [rw] project_name
924
- # The name of the AWS CodeBuild build project that the cache will be
925
- # reset for.
943
+ # The name of the AWS CodeBuild build project that the cache is reset
944
+ # for.
926
945
  # @return [String]
927
946
  #
928
947
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/InvalidateProjectCacheInput AWS API Documentation
@@ -1080,14 +1099,13 @@ module Aws::CodeBuild
1080
1099
  # The criterion to be used to list build project names. Valid values
1081
1100
  # include:
1082
1101
  #
1083
- # * `CREATED_TIME`\: List the build project names based on when each
1084
- # build project was created.
1102
+ # * `CREATED_TIME`\: List based on when each build project was
1103
+ # created.
1085
1104
  #
1086
- # * `LAST_MODIFIED_TIME`\: List the build project names based on when
1087
- # information about each build project was last changed.
1105
+ # * `LAST_MODIFIED_TIME`\: List based on when information about each
1106
+ # build project was last changed.
1088
1107
  #
1089
- # * `NAME`\: List the build project names based on each build
1090
- # project's name.
1108
+ # * `NAME`\: List based on each build project's name.
1091
1109
  #
1092
1110
  # Use `sortOrder` to specify in what order to list the build project
1093
1111
  # names based on the preceding criteria.
@@ -1096,9 +1114,9 @@ module Aws::CodeBuild
1096
1114
  # @!attribute [rw] sort_order
1097
1115
  # The order in which to list build projects. Valid values include:
1098
1116
  #
1099
- # * `ASCENDING`\: List the build project names in ascending order.
1117
+ # * `ASCENDING`\: List in ascending order.
1100
1118
  #
1101
- # * `DESCENDING`\: List the build project names in descending order.
1119
+ # * `DESCENDING`\: List in descending order.
1102
1120
  #
1103
1121
  # Use `sortBy` to specify the criterion to be used to list build
1104
1122
  # project names.
@@ -1143,8 +1161,8 @@ module Aws::CodeBuild
1143
1161
  include Aws::Structure
1144
1162
  end
1145
1163
 
1146
- # Information about logs for a build project. Logs can be Amazon
1147
- # CloudWatch Logs, built in a specified S3 bucket, or both.
1164
+ # Information about logs for a build project. These can be logs in
1165
+ # Amazon CloudWatch Logs, built in a specified S3 bucket, or both.
1148
1166
  #
1149
1167
  # @note When making an API call, you may pass LogsConfig
1150
1168
  # data as a hash:
@@ -1194,7 +1212,7 @@ module Aws::CodeBuild
1194
1212
  # @return [String]
1195
1213
  #
1196
1214
  # @!attribute [rw] s3_deep_link
1197
- # The URL to an individual build log in an S3 bucket.
1215
+ # The URL to a build log in an S3 bucket.
1198
1216
  # @return [String]
1199
1217
  #
1200
1218
  # @!attribute [rw] cloud_watch_logs
@@ -1236,15 +1254,15 @@ module Aws::CodeBuild
1236
1254
  end
1237
1255
 
1238
1256
  # Additional information about a build phase that has an error. You can
1239
- # use this information to help troubleshoot a failed build.
1257
+ # use this information for troubleshooting.
1240
1258
  #
1241
1259
  # @!attribute [rw] status_code
1242
1260
  # The status code for the context of the build phase.
1243
1261
  # @return [String]
1244
1262
  #
1245
1263
  # @!attribute [rw] message
1246
- # An explanation of the build phase's context. This explanation might
1247
- # include a command ID and an exit code.
1264
+ # An explanation of the build phase's context. This might include a
1265
+ # command ID and an exit code.
1248
1266
  # @return [String]
1249
1267
  #
1250
1268
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/PhaseContext AWS API Documentation
@@ -1306,12 +1324,17 @@ module Aws::CodeBuild
1306
1324
  # completed. The default is 60 minutes.
1307
1325
  # @return [Integer]
1308
1326
  #
1327
+ # @!attribute [rw] queued_timeout_in_minutes
1328
+ # The number of minutes a build is allowed to be queued before it
1329
+ # times out.
1330
+ # @return [Integer]
1331
+ #
1309
1332
  # @!attribute [rw] encryption_key
1310
1333
  # The AWS Key Management Service (AWS KMS) customer master key (CMK)
1311
1334
  # to be used for encrypting the build output artifacts.
1312
1335
  #
1313
- # This is expressed either as the CMK's Amazon Resource Name (ARN)
1314
- # or, if specified, the CMK's alias (using the format
1336
+ # This is expressed either as the Amazon Resource Name (ARN) of the
1337
+ # CMK or, if specified, the CMK's alias (using the format
1315
1338
  # `alias/alias-name `).
1316
1339
  # @return [String]
1317
1340
  #
@@ -1337,8 +1360,7 @@ module Aws::CodeBuild
1337
1360
  # @return [Types::Webhook]
1338
1361
  #
1339
1362
  # @!attribute [rw] vpc_config
1340
- # Information about the VPC configuration that AWS CodeBuild will
1341
- # access.
1363
+ # Information about the VPC configuration that AWS CodeBuild accesses.
1342
1364
  # @return [Types::VpcConfig]
1343
1365
  #
1344
1366
  # @!attribute [rw] badge
@@ -1347,7 +1369,7 @@ module Aws::CodeBuild
1347
1369
  #
1348
1370
  # @!attribute [rw] logs_config
1349
1371
  # Information about logs for the build project. A project can create
1350
- # Amazon CloudWatch Logs, logs in an S3 bucket, or both.
1372
+ # logs in Amazon CloudWatch Logs, an S3 bucket, or both.
1351
1373
  # @return [Types::LogsConfig]
1352
1374
  #
1353
1375
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/Project AWS API Documentation
@@ -1364,6 +1386,7 @@ module Aws::CodeBuild
1364
1386
  :environment,
1365
1387
  :service_role,
1366
1388
  :timeout_in_minutes,
1389
+ :queued_timeout_in_minutes,
1367
1390
  :encryption_key,
1368
1391
  :tags,
1369
1392
  :created,
@@ -1395,63 +1418,61 @@ module Aws::CodeBuild
1395
1418
  # @!attribute [rw] type
1396
1419
  # The type of build output artifact. Valid values include:
1397
1420
  #
1398
- # * `CODEPIPELINE`\: The build project will have build output
1399
- # generated through AWS CodePipeline.
1421
+ # * `CODEPIPELINE`\: The build project has build output generated
1422
+ # through AWS CodePipeline.
1400
1423
  #
1401
- # * `NO_ARTIFACTS`\: The build project will not produce any build
1424
+ # * `NO_ARTIFACTS`\: The build project does not produce any build
1402
1425
  # output.
1403
1426
  #
1404
- # * `S3`\: The build project will store build output in Amazon Simple
1427
+ # * `S3`\: The build project stores build output in Amazon Simple
1405
1428
  # Storage Service (Amazon S3).
1406
1429
  # @return [String]
1407
1430
  #
1408
1431
  # @!attribute [rw] location
1409
- # Information about the build output artifact location, as follows:
1432
+ # Information about the build output artifact location:
1410
1433
  #
1411
- # * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
1412
- # ignore this value if specified. This is because AWS CodePipeline
1413
- # manages its build output locations instead of AWS CodeBuild.
1434
+ # * If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this
1435
+ # value if specified. This is because AWS CodePipeline manages its
1436
+ # build output locations instead of AWS CodeBuild.
1414
1437
  #
1415
- # * If `type` is set to `NO_ARTIFACTS`, then this value will be
1416
- # ignored if specified, because no build output will be produced.
1438
+ # * If `type` is set to `NO_ARTIFACTS`, this value is ignored if
1439
+ # specified, because no build output is produced.
1417
1440
  #
1418
1441
  # * If `type` is set to `S3`, this is the name of the output bucket.
1419
1442
  # @return [String]
1420
1443
  #
1421
1444
  # @!attribute [rw] path
1422
1445
  # Along with `namespaceType` and `name`, the pattern that AWS
1423
- # CodeBuild will use to name and store the output artifact, as
1424
- # follows:
1446
+ # CodeBuild uses to name and store the output artifact:
1425
1447
  #
1426
- # * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
1427
- # ignore this value if specified. This is because AWS CodePipeline
1428
- # manages its build output names instead of AWS CodeBuild.
1448
+ # * If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this
1449
+ # value if specified. This is because AWS CodePipeline manages its
1450
+ # build output names instead of AWS CodeBuild.
1429
1451
  #
1430
- # * If `type` is set to `NO_ARTIFACTS`, then this value will be
1431
- # ignored if specified, because no build output will be produced.
1452
+ # * If `type` is set to `NO_ARTIFACTS`, this value is ignored if
1453
+ # specified, because no build output is produced.
1432
1454
  #
1433
1455
  # * If `type` is set to `S3`, this is the path to the output artifact.
1434
- # If `path` is not specified, then `path` will not be used.
1456
+ # If `path` is not specified, `path` is not used.
1435
1457
  #
1436
1458
  # For example, if `path` is set to `MyArtifacts`, `namespaceType` is
1437
- # set to `NONE`, and `name` is set to `MyArtifact.zip`, then the
1438
- # output artifact would be stored in the output bucket at
1459
+ # set to `NONE`, and `name` is set to `MyArtifact.zip`, the output
1460
+ # artifact is stored in the output bucket at
1439
1461
  # `MyArtifacts/MyArtifact.zip`.
1440
1462
  # @return [String]
1441
1463
  #
1442
1464
  # @!attribute [rw] namespace_type
1443
- # Along with `path` and `name`, the pattern that AWS CodeBuild will
1444
- # use to determine the name and location to store the output artifact,
1445
- # as follows:
1465
+ # Along with `path` and `name`, the pattern that AWS CodeBuild uses to
1466
+ # determine the name and location to store the output artifact:
1446
1467
  #
1447
- # * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
1448
- # ignore this value if specified. This is because AWS CodePipeline
1449
- # manages its build output names instead of AWS CodeBuild.
1468
+ # * If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this
1469
+ # value if specified. This is because AWS CodePipeline manages its
1470
+ # build output names instead of AWS CodeBuild.
1450
1471
  #
1451
- # * If `type` is set to `NO_ARTIFACTS`, then this value will be
1452
- # ignored if specified, because no build output will be produced.
1472
+ # * If `type` is set to `NO_ARTIFACTS`, this value is ignored if
1473
+ # specified, because no build output is produced.
1453
1474
  #
1454
- # * If `type` is set to `S3`, then valid values include:
1475
+ # * If `type` is set to `S3`, valid values include:
1455
1476
  #
1456
1477
  # * `BUILD_ID`\: Include the build ID in the location of the build
1457
1478
  # output artifact.
@@ -1460,65 +1481,63 @@ module Aws::CodeBuild
1460
1481
  # `namespaceType` is not specified.
1461
1482
  #
1462
1483
  # For example, if `path` is set to `MyArtifacts`, `namespaceType` is
1463
- # set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, then the
1464
- # output artifact would be stored in
1465
- # `MyArtifacts/build-ID/MyArtifact.zip`.
1484
+ # set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, the output
1485
+ # artifact is stored in `MyArtifacts/build-ID/MyArtifact.zip`.
1466
1486
  # @return [String]
1467
1487
  #
1468
1488
  # @!attribute [rw] name
1469
1489
  # Along with `path` and `namespaceType`, the pattern that AWS
1470
- # CodeBuild will use to name and store the output artifact, as
1471
- # follows:
1490
+ # CodeBuild uses to name and store the output artifact:
1472
1491
  #
1473
- # * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
1474
- # ignore this value if specified. This is because AWS CodePipeline
1475
- # manages its build output names instead of AWS CodeBuild.
1492
+ # * If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this
1493
+ # value if specified. This is because AWS CodePipeline manages its
1494
+ # build output names instead of AWS CodeBuild.
1476
1495
  #
1477
- # * If `type` is set to `NO_ARTIFACTS`, then this value will be
1478
- # ignored if specified, because no build output will be produced.
1496
+ # * If `type` is set to `NO_ARTIFACTS`, this value is ignored if
1497
+ # specified, because no build output is produced.
1479
1498
  #
1480
1499
  # * If `type` is set to `S3`, this is the name of the output artifact
1481
- # object. If you set the name to be a forward slash ("/"), then
1482
- # the artifact is stored in the root of the output bucket.
1500
+ # object. If you set the name to be a forward slash ("/"), the
1501
+ # artifact is stored in the root of the output bucket.
1483
1502
  #
1484
1503
  # For example:
1485
1504
  #
1486
1505
  # * If `path` is set to `MyArtifacts`, `namespaceType` is set to
1487
1506
  # `BUILD_ID`, and `name` is set to `MyArtifact.zip`, then the output
1488
- # artifact would be stored in `MyArtifacts/build-ID/MyArtifact.zip`.
1507
+ # artifact is stored in `MyArtifacts/build-ID/MyArtifact.zip`.
1489
1508
  #
1490
1509
  # * If `path` is empty, `namespaceType` is set to `NONE`, and `name`
1491
- # is set to "`/`", then the output artifact would be stored in the
1492
- # root of the output bucket.
1510
+ # is set to "`/`", the output artifact is stored in the root of
1511
+ # the output bucket.
1493
1512
  #
1494
1513
  # * If `path` is set to `MyArtifacts`, `namespaceType` is set to
1495
- # `BUILD_ID`, and `name` is set to "`/`", then the output artifact
1496
- # would be stored in `MyArtifacts/build-ID `.
1514
+ # `BUILD_ID`, and `name` is set to "`/`", the output artifact is
1515
+ # stored in `MyArtifacts/build-ID `.
1497
1516
  # @return [String]
1498
1517
  #
1499
1518
  # @!attribute [rw] packaging
1500
- # The type of build output artifact to create, as follows:
1519
+ # The type of build output artifact to create:
1501
1520
  #
1502
- # * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
1503
- # ignore this value if specified. This is because AWS CodePipeline
1504
- # manages its build output artifacts instead of AWS CodeBuild.
1521
+ # * If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this
1522
+ # value if specified. This is because AWS CodePipeline manages its
1523
+ # build output artifacts instead of AWS CodeBuild.
1505
1524
  #
1506
- # * If `type` is set to `NO_ARTIFACTS`, then this value will be
1507
- # ignored if specified, because no build output will be produced.
1525
+ # * If `type` is set to `NO_ARTIFACTS`, this value is ignored if
1526
+ # specified, because no build output is produced.
1508
1527
  #
1509
1528
  # * If `type` is set to `S3`, valid values include:
1510
1529
  #
1511
- # * `NONE`\: AWS CodeBuild will create in the output bucket a folder
1512
- # containing the build output. This is the default if `packaging`
1513
- # is not specified.
1530
+ # * `NONE`\: AWS CodeBuild creates in the output bucket a folder
1531
+ # that contains the build output. This is the default if
1532
+ # `packaging` is not specified.
1514
1533
  #
1515
- # * `ZIP`\: AWS CodeBuild will create in the output bucket a ZIP
1516
- # file containing the build output.
1534
+ # * `ZIP`\: AWS CodeBuild creates in the output bucket a ZIP file
1535
+ # that contains the build output.
1517
1536
  # @return [String]
1518
1537
  #
1519
1538
  # @!attribute [rw] override_artifact_name
1520
- # If this flag is set, a name specified in the buildspec file
1521
- # overrides the artifact name. The name specified in a buildspec file
1539
+ # If this flag is set, a name specified in the build spec file
1540
+ # overrides the artifact name. The name specified in a build spec file
1522
1541
  # is calculated at build time and uses the Shell Command Language. For
1523
1542
  # example, you can append a date and time to your artifact name so
1524
1543
  # that it is always unique.
@@ -1526,9 +1545,9 @@ module Aws::CodeBuild
1526
1545
  #
1527
1546
  # @!attribute [rw] encryption_disabled
1528
1547
  # Set to true if you do not want your output artifacts encrypted. This
1529
- # option is only valid if your artifacts type is Amazon S3. If this is
1530
- # set with another artifacts type, an invalidInputException will be
1531
- # thrown.
1548
+ # option is valid only if your artifacts type is Amazon Simple Storage
1549
+ # Service (Amazon S3). If this is set with another artifacts type, an
1550
+ # invalidInputException is thrown.
1532
1551
  # @return [Boolean]
1533
1552
  #
1534
1553
  # @!attribute [rw] artifact_identifier
@@ -1553,13 +1572,16 @@ module Aws::CodeBuild
1553
1572
  # Information about the build badge for the build project.
1554
1573
  #
1555
1574
  # @!attribute [rw] badge_enabled
1556
- # Set this to true to generate a publicly-accessible URL for your
1575
+ # Set this to true to generate a publicly accessible URL for your
1557
1576
  # project's build badge.
1558
1577
  # @return [Boolean]
1559
1578
  #
1560
1579
  # @!attribute [rw] badge_request_url
1561
1580
  # The publicly-accessible URL through which you can access the build
1562
1581
  # badge for your project.
1582
+ #
1583
+ # The publicly accessible URL through which you can access the build
1584
+ # badge for your project.
1563
1585
  # @return [String]
1564
1586
  #
1565
1587
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ProjectBadge AWS API Documentation
@@ -1583,15 +1605,15 @@ module Aws::CodeBuild
1583
1605
  # @!attribute [rw] type
1584
1606
  # The type of cache used by the build project. Valid values include:
1585
1607
  #
1586
- # * `NO_CACHE`\: The build project will not use any cache.
1608
+ # * `NO_CACHE`\: The build project does not use any cache.
1587
1609
  #
1588
- # * `S3`\: The build project will read and write from/to S3.
1610
+ # * `S3`\: The build project reads and writes from and to S3.
1589
1611
  # @return [String]
1590
1612
  #
1591
1613
  # @!attribute [rw] location
1592
- # Information about the cache location, as follows:
1614
+ # Information about the cache location:
1593
1615
  #
1594
- # * `NO_CACHE`\: This value will be ignored.
1616
+ # * `NO_CACHE`\: This value is ignored.
1595
1617
  #
1596
1618
  # * `S3`\: This is the S3 bucket name/prefix.
1597
1619
  # @return [String]
@@ -1633,7 +1655,7 @@ module Aws::CodeBuild
1633
1655
  # @return [String]
1634
1656
  #
1635
1657
  # @!attribute [rw] compute_type
1636
- # Information about the compute resources the build project will use.
1658
+ # Information about the compute resources the build project uses.
1637
1659
  # Available values include:
1638
1660
  #
1639
1661
  # * `BUILD_GENERAL1_SMALL`\: Use up to 3 GB memory and 2 vCPUs for
@@ -1656,13 +1678,12 @@ module Aws::CodeBuild
1656
1678
  # true only if the build project is be used to build Docker images,
1657
1679
  # and the specified build environment image is not provided by AWS
1658
1680
  # CodeBuild with Docker support. Otherwise, all associated builds that
1659
- # attempt to interact with the Docker daemon will fail. Note that you
1660
- # must also start the Docker daemon so that builds can interact with
1661
- # it. One way to do this is to initialize the Docker daemon during the
1662
- # install phase of your build spec by running the following build
1663
- # commands. (Do not run the following build commands if the specified
1664
- # build environment image is provided by AWS CodeBuild with Docker
1665
- # support.)
1681
+ # attempt to interact with the Docker daemon fail. You must also start
1682
+ # the Docker daemon so that builds can interact with it. One way to do
1683
+ # this is to initialize the Docker daemon during the install phase of
1684
+ # your build spec by running the following build commands. (Do not run
1685
+ # these commands if the specified build environment image is provided
1686
+ # by AWS CodeBuild with Docker support.)
1666
1687
  #
1667
1688
  # If the operating system's base image is Ubuntu Linux:
1668
1689
  #
@@ -1738,9 +1759,9 @@ module Aws::CodeBuild
1738
1759
  #
1739
1760
  # * For source code settings that are specified in the source action
1740
1761
  # of a pipeline in AWS CodePipeline, `location` should not be
1741
- # specified. If it is specified, AWS CodePipeline will ignore it.
1742
- # This is because AWS CodePipeline uses the settings in a
1743
- # pipeline's source action instead of this value.
1762
+ # specified. If it is specified, AWS CodePipeline ignores it. This
1763
+ # is because AWS CodePipeline uses the settings in a pipeline's
1764
+ # source action instead of this value.
1744
1765
  #
1745
1766
  # * For source code in an AWS CodeCommit repository, the HTTPS clone
1746
1767
  # URL to the repository that contains the source code and the build
@@ -1758,29 +1779,28 @@ module Aws::CodeBuild
1758
1779
  # example, ` bucket-name/path/to/source-code/folder/`).
1759
1780
  #
1760
1781
  # * For source code in a GitHub repository, the HTTPS clone URL to the
1761
- # repository that contains the source and the build spec. Also, you
1762
- # must connect your AWS account to your GitHub account. To do this,
1763
- # use the AWS CodeBuild console to begin creating a build project.
1764
- # When you use the console to connect (or reconnect) with GitHub, on
1765
- # the GitHub **Authorize application** page that displays, for
1766
- # **Organization access**, choose **Request access** next to each
1767
- # repository you want to allow AWS CodeBuild to have access to. Then
1768
- # choose **Authorize application**. (After you have connected to
1769
- # your GitHub account, you do not need to finish creating the build
1770
- # project, and you may then leave the AWS CodeBuild console.) To
1771
- # instruct AWS CodeBuild to then use this connection, in the
1772
- # `source` object, set the `auth` object's `type` value to `OAUTH`.
1782
+ # repository that contains the source and the build spec. You must
1783
+ # connect your AWS account to your GitHub account. Use the AWS
1784
+ # CodeBuild console to start creating a build project. When you use
1785
+ # the console to connect (or reconnect) with GitHub, on the GitHub
1786
+ # **Authorize application** page, for **Organization access**,
1787
+ # choose **Request access** next to each repository you want to
1788
+ # allow AWS CodeBuild to have access to, and then choose **Authorize
1789
+ # application**. (After you have connected to your GitHub account,
1790
+ # you do not need to finish creating the build project. You can
1791
+ # leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use
1792
+ # this connection, in the `source` object, set the `auth` object's
1793
+ # `type` value to `OAUTH`.
1773
1794
  #
1774
1795
  # * For source code in a Bitbucket repository, the HTTPS clone URL to
1775
- # the repository that contains the source and the build spec. Also,
1776
- # you must connect your AWS account to your Bitbucket account. To do
1777
- # this, use the AWS CodeBuild console to begin creating a build
1778
- # project. When you use the console to connect (or reconnect) with
1779
- # Bitbucket, on the Bitbucket **Confirm access to your account**
1780
- # page that displays, choose **Grant access**. (After you have
1781
- # connected to your Bitbucket account, you do not need to finish
1782
- # creating the build project, and you may then leave the AWS
1783
- # CodeBuild console.) To instruct AWS CodeBuild to then use this
1796
+ # the repository that contains the source and the build spec. You
1797
+ # must connect your AWS account to your Bitbucket account. Use the
1798
+ # AWS CodeBuild console to start creating a build project. When you
1799
+ # use the console to connect (or reconnect) with Bitbucket, on the
1800
+ # Bitbucket **Confirm access to your account** page, choose **Grant
1801
+ # access**. (After you have connected to your Bitbucket account, you
1802
+ # do not need to finish creating the build project. You can leave
1803
+ # the AWS CodeBuild console.) To instruct AWS CodeBuild to use this
1784
1804
  # connection, in the `source` object, set the `auth` object's
1785
1805
  # `type` value to `OAUTH`.
1786
1806
  # @return [String]
@@ -1808,7 +1828,7 @@ module Aws::CodeBuild
1808
1828
  #
1809
1829
  # @!attribute [rw] report_build_status
1810
1830
  # Set to true to report the status of a build's start and finish to
1811
- # your source provider. This option is only valid when your source
1831
+ # your source provider. This option is valid only when your source
1812
1832
  # provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set
1813
1833
  # and you use a different source provider, an invalidInputException is
1814
1834
  # thrown.
@@ -1860,18 +1880,18 @@ module Aws::CodeBuild
1860
1880
  # * For GitHub: the commit ID, pull request ID, branch name, or tag
1861
1881
  # name that corresponds to the version of the source code you want
1862
1882
  # to build. If a pull request ID is specified, it must use the
1863
- # format `pr/pull-request-ID` (for example `pr/25`). If a branch
1864
- # name is specified, the branch's HEAD commit ID will be used. If
1865
- # not specified, the default branch's HEAD commit ID will be used.
1883
+ # format `pr/pull-request-ID` (for example, `pr/25`). If a branch
1884
+ # name is specified, the branch's HEAD commit ID is used. If not
1885
+ # specified, the default branch's HEAD commit ID is used.
1866
1886
  #
1867
1887
  # * For Bitbucket: the commit ID, branch name, or tag name that
1868
1888
  # corresponds to the version of the source code you want to build.
1869
- # If a branch name is specified, the branch's HEAD commit ID will
1870
- # be used. If not specified, the default branch's HEAD commit ID
1871
- # will be used.
1889
+ # If a branch name is specified, the branch's HEAD commit ID is
1890
+ # used. If not specified, the default branch's HEAD commit ID is
1891
+ # used.
1872
1892
  #
1873
1893
  # * For Amazon Simple Storage Service (Amazon S3): the version ID of
1874
- # the object representing the build input ZIP file to use.
1894
+ # the object that represents the build input ZIP file to use.
1875
1895
  # @return [String]
1876
1896
  #
1877
1897
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ProjectSourceVersion AWS API Documentation
@@ -2026,6 +2046,7 @@ module Aws::CodeBuild
2026
2046
  # service_role_override: "NonEmptyString",
2027
2047
  # privileged_mode_override: false,
2028
2048
  # timeout_in_minutes_override: 1,
2049
+ # queued_timeout_in_minutes_override: 1,
2029
2050
  # idempotency_token: "String",
2030
2051
  # logs_config_override: {
2031
2052
  # cloud_watch_logs: {
@@ -2057,8 +2078,8 @@ module Aws::CodeBuild
2057
2078
  #
2058
2079
  # @!attribute [rw] source_version
2059
2080
  # A version of the build input to be built, for this build only. If
2060
- # not specified, the latest version will be used. If specified, must
2061
- # be one of:
2081
+ # not specified, the latest version is used. If specified, must be one
2082
+ # of:
2062
2083
  #
2063
2084
  # * For AWS CodeCommit: the commit ID to use.
2064
2085
  #
@@ -2066,17 +2087,17 @@ module Aws::CodeBuild
2066
2087
  # name that corresponds to the version of the source code you want
2067
2088
  # to build. If a pull request ID is specified, it must use the
2068
2089
  # format `pr/pull-request-ID` (for example `pr/25`). If a branch
2069
- # name is specified, the branch's HEAD commit ID will be used. If
2070
- # not specified, the default branch's HEAD commit ID will be used.
2090
+ # name is specified, the branch's HEAD commit ID is used. If not
2091
+ # specified, the default branch's HEAD commit ID is used.
2071
2092
  #
2072
2093
  # * For Bitbucket: the commit ID, branch name, or tag name that
2073
2094
  # corresponds to the version of the source code you want to build.
2074
- # If a branch name is specified, the branch's HEAD commit ID will
2075
- # be used. If not specified, the default branch's HEAD commit ID
2076
- # will be used.
2095
+ # If a branch name is specified, the branch's HEAD commit ID is
2096
+ # used. If not specified, the default branch's HEAD commit ID is
2097
+ # used.
2077
2098
  #
2078
2099
  # * For Amazon Simple Storage Service (Amazon S3): the version ID of
2079
- # the object representing the build input ZIP file to use.
2100
+ # the object that represents the build input ZIP file to use.
2080
2101
  # @return [String]
2081
2102
  #
2082
2103
  # @!attribute [rw] artifacts_override
@@ -2094,13 +2115,13 @@ module Aws::CodeBuild
2094
2115
  # @return [Array<Types::EnvironmentVariable>]
2095
2116
  #
2096
2117
  # @!attribute [rw] source_type_override
2097
- # A source input type for this build that overrides the source input
2118
+ # A source input type, for this build, that overrides the source input
2098
2119
  # defined in the build project.
2099
2120
  # @return [String]
2100
2121
  #
2101
2122
  # @!attribute [rw] source_location_override
2102
- # A location that overrides for this build the source location for the
2103
- # one defined in the build project.
2123
+ # A location that overrides, for this build, the source location for
2124
+ # the one defined in the build project.
2104
2125
  # @return [String]
2105
2126
  #
2106
2127
  # @!attribute [rw] source_auth_override
@@ -2175,6 +2196,11 @@ module Aws::CodeBuild
2175
2196
  # in the build project.
2176
2197
  # @return [Integer]
2177
2198
  #
2199
+ # @!attribute [rw] queued_timeout_in_minutes_override
2200
+ # The number of minutes a build is allowed to be queued before it
2201
+ # times out.
2202
+ # @return [Integer]
2203
+ #
2178
2204
  # @!attribute [rw] idempotency_token
2179
2205
  # A unique, case sensitive identifier you provide to ensure the
2180
2206
  # idempotency of the StartBuild request. The token is included in the
@@ -2213,6 +2239,7 @@ module Aws::CodeBuild
2213
2239
  :service_role_override,
2214
2240
  :privileged_mode_override,
2215
2241
  :timeout_in_minutes_override,
2242
+ :queued_timeout_in_minutes_override,
2216
2243
  :idempotency_token,
2217
2244
  :logs_config_override)
2218
2245
  include Aws::Structure
@@ -2365,6 +2392,7 @@ module Aws::CodeBuild
2365
2392
  # },
2366
2393
  # service_role: "NonEmptyString",
2367
2394
  # timeout_in_minutes: 1,
2395
+ # queued_timeout_in_minutes: 1,
2368
2396
  # encryption_key: "NonEmptyString",
2369
2397
  # tags: [
2370
2398
  # {
@@ -2443,12 +2471,18 @@ module Aws::CodeBuild
2443
2471
  # get marked as completed.
2444
2472
  # @return [Integer]
2445
2473
  #
2474
+ # @!attribute [rw] queued_timeout_in_minutes
2475
+ # The number of minutes a build is allowed to be queued before it
2476
+ # times out.
2477
+ # @return [Integer]
2478
+ #
2446
2479
  # @!attribute [rw] encryption_key
2447
2480
  # The replacement AWS Key Management Service (AWS KMS) customer master
2448
2481
  # key (CMK) to be used for encrypting the build output artifacts.
2449
2482
  #
2450
- # You can specify either the CMK's Amazon Resource Name (ARN) or, if
2451
- # available, the CMK's alias (using the format `alias/alias-name `).
2483
+ # You can specify either the Amazon Resource Name (ARN)of the CMK or,
2484
+ # if available, the CMK's alias (using the format `alias/alias-name
2485
+ # `).
2452
2486
  # @return [String]
2453
2487
  #
2454
2488
  # @!attribute [rw] tags
@@ -2464,13 +2498,13 @@ module Aws::CodeBuild
2464
2498
  # @return [Types::VpcConfig]
2465
2499
  #
2466
2500
  # @!attribute [rw] badge_enabled
2467
- # Set this to true to generate a publicly-accessible URL for your
2501
+ # Set this to true to generate a publicly accessible URL for your
2468
2502
  # project's build badge.
2469
2503
  # @return [Boolean]
2470
2504
  #
2471
2505
  # @!attribute [rw] logs_config
2472
2506
  # Information about logs for the build project. A project can create
2473
- # Amazon CloudWatch Logs, logs in an S3 bucket, or both.
2507
+ # logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.
2474
2508
  # @return [Types::LogsConfig]
2475
2509
  #
2476
2510
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/UpdateProjectInput AWS API Documentation
@@ -2486,6 +2520,7 @@ module Aws::CodeBuild
2486
2520
  :environment,
2487
2521
  :service_role,
2488
2522
  :timeout_in_minutes,
2523
+ :queued_timeout_in_minutes,
2489
2524
  :encryption_key,
2490
2525
  :tags,
2491
2526
  :vpc_config,
@@ -2519,17 +2554,16 @@ module Aws::CodeBuild
2519
2554
  # @return [String]
2520
2555
  #
2521
2556
  # @!attribute [rw] branch_filter
2522
- # A regular expression used to determine which branches in a
2523
- # repository are built when a webhook is triggered. If the name of a
2524
- # branch matches the regular expression, then it is built. If it
2525
- # doesn't match, then it is not. If `branchFilter` is empty, then all
2526
- # branches are built.
2557
+ # A regular expression used to determine which repository branches are
2558
+ # built when a webhook is triggered. If the name of a branch matches
2559
+ # the regular expression, then it is built. If `branchFilter` is
2560
+ # empty, then all branches are built.
2527
2561
  # @return [String]
2528
2562
  #
2529
2563
  # @!attribute [rw] rotate_secret
2530
2564
  # A boolean value that specifies whether the associated GitHub
2531
2565
  # repository's secret token should be updated. If you use Bitbucket
2532
- # for your repository then `rotateSecret` is ignored.
2566
+ # for your repository, `rotateSecret` is ignored.
2533
2567
  # @return [Boolean]
2534
2568
  #
2535
2569
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/UpdateWebhookInput AWS API Documentation
@@ -2553,8 +2587,7 @@ module Aws::CodeBuild
2553
2587
  include Aws::Structure
2554
2588
  end
2555
2589
 
2556
- # Information about the VPC configuration that AWS CodeBuild will
2557
- # access.
2590
+ # Information about the VPC configuration that AWS CodeBuild accesses.
2558
2591
  #
2559
2592
  # @note When making an API call, you may pass VpcConfig
2560
2593
  # data as a hash:
@@ -2594,7 +2627,7 @@ module Aws::CodeBuild
2594
2627
  # @return [String]
2595
2628
  #
2596
2629
  # @!attribute [rw] payload_url
2597
- # The CodeBuild endpoint where webhook events are sent.
2630
+ # The AWS CodeBuild endpoint where webhook events are sent.
2598
2631
  # @return [String]
2599
2632
  #
2600
2633
  # @!attribute [rw] secret
@@ -2606,16 +2639,15 @@ module Aws::CodeBuild
2606
2639
  # @return [String]
2607
2640
  #
2608
2641
  # @!attribute [rw] branch_filter
2609
- # A regular expression used to determine which branches in a
2610
- # repository are built when a webhook is triggered. If the name of a
2611
- # branch matches the regular expression, then it is built. If it
2612
- # doesn't match, then it is not. If `branchFilter` is empty, then all
2613
- # branches are built.
2642
+ # A regular expression used to determine which repository branches are
2643
+ # built when a webhook is triggered. If the name of a branch matches
2644
+ # the regular expression, then it is built. If `branchFilter` is
2645
+ # empty, then all branches are built.
2614
2646
  # @return [String]
2615
2647
  #
2616
2648
  # @!attribute [rw] last_modified_secret
2617
- # A timestamp indicating the last time a repository's secret token
2618
- # was modified.
2649
+ # A timestamp that indicates the last time a repository's secret
2650
+ # token was modified.
2619
2651
  # @return [Time]
2620
2652
  #
2621
2653
  # @see http://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/Webhook AWS API Documentation