aws-sdk-codebuild 1.0.0.rc2
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.
- checksums.yaml +7 -0
- data/lib/aws-sdk-codebuild.rb +47 -0
- data/lib/aws-sdk-codebuild/client.rb +858 -0
- data/lib/aws-sdk-codebuild/client_api.rb +430 -0
- data/lib/aws-sdk-codebuild/customizations.rb +0 -0
- data/lib/aws-sdk-codebuild/errors.rb +23 -0
- data/lib/aws-sdk-codebuild/resource.rb +25 -0
- data/lib/aws-sdk-codebuild/types.rb +1320 -0
- metadata +80 -0
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module CodeBuild
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,1320 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module CodeBuild
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass BatchGetBuildsInput
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# ids: ["NonEmptyString"], # required
|
17
|
+
# }
|
18
|
+
# @!attribute [rw] ids
|
19
|
+
# The IDs of the builds to get information about.
|
20
|
+
# @return [Array<String>]
|
21
|
+
class BatchGetBuildsInput < Struct.new(
|
22
|
+
:ids)
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @!attribute [rw] builds
|
27
|
+
# Information about the requested builds.
|
28
|
+
# @return [Array<Types::Build>]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] builds_not_found
|
31
|
+
# The IDs of builds for which information could not be found.
|
32
|
+
# @return [Array<String>]
|
33
|
+
class BatchGetBuildsOutput < Struct.new(
|
34
|
+
:builds,
|
35
|
+
:builds_not_found)
|
36
|
+
include Aws::Structure
|
37
|
+
end
|
38
|
+
|
39
|
+
# @note When making an API call, pass BatchGetProjectsInput
|
40
|
+
# data as a hash:
|
41
|
+
#
|
42
|
+
# {
|
43
|
+
# names: ["NonEmptyString"], # required
|
44
|
+
# }
|
45
|
+
# @!attribute [rw] names
|
46
|
+
# The names of the build projects to get information about.
|
47
|
+
# @return [Array<String>]
|
48
|
+
class BatchGetProjectsInput < Struct.new(
|
49
|
+
:names)
|
50
|
+
include Aws::Structure
|
51
|
+
end
|
52
|
+
|
53
|
+
# @!attribute [rw] projects
|
54
|
+
# Information about the requested build projects.
|
55
|
+
# @return [Array<Types::Project>]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] projects_not_found
|
58
|
+
# The names of build projects for which information could not be
|
59
|
+
# found.
|
60
|
+
# @return [Array<String>]
|
61
|
+
class BatchGetProjectsOutput < Struct.new(
|
62
|
+
:projects,
|
63
|
+
:projects_not_found)
|
64
|
+
include Aws::Structure
|
65
|
+
end
|
66
|
+
|
67
|
+
# Information about a build.
|
68
|
+
# @!attribute [rw] id
|
69
|
+
# The build's unique ID.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] arn
|
73
|
+
# The build's Amazon Resource Name (ARN).
|
74
|
+
# @return [String]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] start_time
|
77
|
+
# When the build process started, expressed in Unix time format.
|
78
|
+
# @return [Time]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] end_time
|
81
|
+
# When the build process ended, expressed in Unix time format.
|
82
|
+
# @return [Time]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] current_phase
|
85
|
+
# The build's current build phase.
|
86
|
+
# @return [String]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] build_status
|
89
|
+
# The build's current status. Valid values include:
|
90
|
+
#
|
91
|
+
# * `FAILED`\: The build failed.
|
92
|
+
#
|
93
|
+
# * `FAULT`\: The build faulted.
|
94
|
+
#
|
95
|
+
# * `IN_PROGRESS`\: The build is still in progress.
|
96
|
+
#
|
97
|
+
# * `STOPPED`\: The build stopped.
|
98
|
+
#
|
99
|
+
# * `SUCCEEDED`\: The build succeeded.
|
100
|
+
#
|
101
|
+
# * `TIMED_OUT`\: The build timed out.
|
102
|
+
# @return [String]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] source_version
|
105
|
+
# Any version identifier for the version of the source code to be
|
106
|
+
# built.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] project_name
|
110
|
+
# The build project's name.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] phases
|
114
|
+
# Information about all previous build phases that have completed, and
|
115
|
+
# information about any current build phase that has not yet
|
116
|
+
# completed.
|
117
|
+
# @return [Array<Types::BuildPhase>]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] source
|
120
|
+
# Information about the source code to be built.
|
121
|
+
# @return [Types::ProjectSource]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] artifacts
|
124
|
+
# Information about the build's output artifacts.
|
125
|
+
# @return [Types::BuildArtifacts]
|
126
|
+
#
|
127
|
+
# @!attribute [rw] environment
|
128
|
+
# Information about the build environment for this build.
|
129
|
+
# @return [Types::ProjectEnvironment]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] logs
|
132
|
+
# Information about the build's logs in Amazon CloudWatch Logs.
|
133
|
+
# @return [Types::LogsLocation]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] timeout_in_minutes
|
136
|
+
# How long in minutes for AWS CodeBuild to wait to timeout this build
|
137
|
+
# if it does not get marked as completed.
|
138
|
+
# @return [Integer]
|
139
|
+
#
|
140
|
+
# @!attribute [rw] build_complete
|
141
|
+
# Whether the build has finished. Valid values include true if
|
142
|
+
# completed; otherwise, false.
|
143
|
+
# @return [Boolean]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] initiator
|
146
|
+
# The entity that started the build. Valid values include:
|
147
|
+
#
|
148
|
+
# * If AWS CodePipeline started the build, the pipeline's name, for
|
149
|
+
# example `codepipeline/my-demo-pipeline`.
|
150
|
+
#
|
151
|
+
# * If an AWS Identity and Access Management (IAM) user started the
|
152
|
+
# build, the user's name, for example `MyUserName`.
|
153
|
+
#
|
154
|
+
# * If the Jenkins plugin for AWS CodeBuild started the build, the
|
155
|
+
# string `CodeBuild-Jenkins-Plugin`.
|
156
|
+
# @return [String]
|
157
|
+
class Build < Struct.new(
|
158
|
+
:id,
|
159
|
+
:arn,
|
160
|
+
:start_time,
|
161
|
+
:end_time,
|
162
|
+
:current_phase,
|
163
|
+
:build_status,
|
164
|
+
:source_version,
|
165
|
+
:project_name,
|
166
|
+
:phases,
|
167
|
+
:source,
|
168
|
+
:artifacts,
|
169
|
+
:environment,
|
170
|
+
:logs,
|
171
|
+
:timeout_in_minutes,
|
172
|
+
:build_complete,
|
173
|
+
:initiator)
|
174
|
+
include Aws::Structure
|
175
|
+
end
|
176
|
+
|
177
|
+
# Information about build output artifacts.
|
178
|
+
# @!attribute [rw] location
|
179
|
+
# Information about the build artifacts' location.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] sha256sum
|
183
|
+
# The SHA-256 hash of the build artifact.
|
184
|
+
#
|
185
|
+
# You can use this hash along with a checksum tool to confirm both
|
186
|
+
# file integrity and authenticity.
|
187
|
+
#
|
188
|
+
# <note markdown="1"> This value is available only if the related build project's
|
189
|
+
# `packaging` value is set to `ZIP`.
|
190
|
+
#
|
191
|
+
# </note>
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] md5sum
|
195
|
+
# The MD5 hash of the build artifact.
|
196
|
+
#
|
197
|
+
# You can use this hash along with a checksum tool to confirm both
|
198
|
+
# file integrity and authenticity.
|
199
|
+
#
|
200
|
+
# <note markdown="1"> This value is available only if the related build project's
|
201
|
+
# `packaging` value is set to `ZIP`.
|
202
|
+
#
|
203
|
+
# </note>
|
204
|
+
# @return [String]
|
205
|
+
class BuildArtifacts < Struct.new(
|
206
|
+
:location,
|
207
|
+
:sha256sum,
|
208
|
+
:md5sum)
|
209
|
+
include Aws::Structure
|
210
|
+
end
|
211
|
+
|
212
|
+
# Information about a stage for a build.
|
213
|
+
# @!attribute [rw] phase_type
|
214
|
+
# The build phase's name. Valid values include:
|
215
|
+
#
|
216
|
+
# * `BUILD`\: Core build activities typically occur in this build
|
217
|
+
# phase.
|
218
|
+
#
|
219
|
+
# * `COMPLETED`\: The build has completed.
|
220
|
+
#
|
221
|
+
# * `DOWNLOAD_SOURCE`\: Source code is being downloaded in this build
|
222
|
+
# phase.
|
223
|
+
#
|
224
|
+
# * `FINALIZING`\: The build process is completing in this build
|
225
|
+
# phase.
|
226
|
+
#
|
227
|
+
# * `INSTALL`\: Installation activities typically occur in this build
|
228
|
+
# phase.
|
229
|
+
#
|
230
|
+
# * `POST_BUILD`\: Post-build activities typically occur in this build
|
231
|
+
# phase.
|
232
|
+
#
|
233
|
+
# * `PRE_BUILD`\: Pre-build activities typically occur in this build
|
234
|
+
# phase.
|
235
|
+
#
|
236
|
+
# * `PROVISIONING`\: The build environment is being set up.
|
237
|
+
#
|
238
|
+
# * `SUBMITTED`\: The build has been submitted.
|
239
|
+
#
|
240
|
+
# * `UPLOAD_ARTIFACTS`\: Build output artifacts are being uploaded to
|
241
|
+
# output location.
|
242
|
+
# @return [String]
|
243
|
+
#
|
244
|
+
# @!attribute [rw] phase_status
|
245
|
+
# The build phase's current status. Valid values include:
|
246
|
+
#
|
247
|
+
# * `FAILED`\: The build phase failed.
|
248
|
+
#
|
249
|
+
# * `FAULT`\: The build phase faulted.
|
250
|
+
#
|
251
|
+
# * `IN_PROGRESS`\: The build phase is still in progress.
|
252
|
+
#
|
253
|
+
# * `STOPPED`\: The build phase stopped.
|
254
|
+
#
|
255
|
+
# * `SUCCEEDED`\: The build phase succeeded.
|
256
|
+
#
|
257
|
+
# * `TIMED_OUT`\: The build phase timed out.
|
258
|
+
# @return [String]
|
259
|
+
#
|
260
|
+
# @!attribute [rw] start_time
|
261
|
+
# When the build phase started, expressed in Unix time format.
|
262
|
+
# @return [Time]
|
263
|
+
#
|
264
|
+
# @!attribute [rw] end_time
|
265
|
+
# When the build phase ended, expressed in Unix time format.
|
266
|
+
# @return [Time]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] duration_in_seconds
|
269
|
+
# How long, in seconds, between the build's phase starting and ending
|
270
|
+
# times.
|
271
|
+
# @return [Integer]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] contexts
|
274
|
+
# Additional information about a build phase, especially to help
|
275
|
+
# troubleshoot a failed build.
|
276
|
+
# @return [Array<Types::PhaseContext>]
|
277
|
+
class BuildPhase < Struct.new(
|
278
|
+
:phase_type,
|
279
|
+
:phase_status,
|
280
|
+
:start_time,
|
281
|
+
:end_time,
|
282
|
+
:duration_in_seconds,
|
283
|
+
:contexts)
|
284
|
+
include Aws::Structure
|
285
|
+
end
|
286
|
+
|
287
|
+
# @note When making an API call, pass CreateProjectInput
|
288
|
+
# data as a hash:
|
289
|
+
#
|
290
|
+
# {
|
291
|
+
# name: "ProjectName", # required
|
292
|
+
# description: "ProjectDescription",
|
293
|
+
# source: { # required
|
294
|
+
# type: "CODECOMMIT", # required, accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3
|
295
|
+
# location: "String",
|
296
|
+
# buildspec: "String",
|
297
|
+
# auth: {
|
298
|
+
# type: "OAUTH", # required, accepts OAUTH
|
299
|
+
# resource: "String",
|
300
|
+
# },
|
301
|
+
# },
|
302
|
+
# artifacts: { # required
|
303
|
+
# type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
|
304
|
+
# location: "String",
|
305
|
+
# path: "String",
|
306
|
+
# namespace_type: "NONE", # accepts NONE, BUILD_ID
|
307
|
+
# name: "String",
|
308
|
+
# packaging: "NONE", # accepts NONE, ZIP
|
309
|
+
# },
|
310
|
+
# environment: { # required
|
311
|
+
# type: "LINUX_CONTAINER", # required, accepts LINUX_CONTAINER
|
312
|
+
# image: "NonEmptyString", # required
|
313
|
+
# compute_type: "BUILD_GENERAL1_SMALL", # required, accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
|
314
|
+
# environment_variables: [
|
315
|
+
# {
|
316
|
+
# name: "NonEmptyString", # required
|
317
|
+
# value: "String", # required
|
318
|
+
# },
|
319
|
+
# ],
|
320
|
+
# },
|
321
|
+
# service_role: "NonEmptyString",
|
322
|
+
# timeout_in_minutes: 1,
|
323
|
+
# encryption_key: "NonEmptyString",
|
324
|
+
# tags: [
|
325
|
+
# {
|
326
|
+
# key: "KeyInput",
|
327
|
+
# value: "ValueInput",
|
328
|
+
# },
|
329
|
+
# ],
|
330
|
+
# }
|
331
|
+
# @!attribute [rw] name
|
332
|
+
# The build project's name.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] description
|
336
|
+
# A meaningful description of the build project.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] source
|
340
|
+
# Information about the build project's build input source code.
|
341
|
+
# @return [Types::ProjectSource]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] artifacts
|
344
|
+
# Information about the build project's build output artifacts.
|
345
|
+
# @return [Types::ProjectArtifacts]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] environment
|
348
|
+
# Information about the build project's build environment.
|
349
|
+
# @return [Types::ProjectEnvironment]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] service_role
|
352
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
353
|
+
# Management (IAM) role that enables AWS CodeBuild to interact with
|
354
|
+
# dependent AWS services on behalf of the AWS account.
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] timeout_in_minutes
|
358
|
+
# How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to
|
359
|
+
# wait until timing out any related build that does not get marked as
|
360
|
+
# completed. The default is 60 minutes.
|
361
|
+
# @return [Integer]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] encryption_key
|
364
|
+
# The AWS Key Management Service (AWS KMS) customer master key (CMK)
|
365
|
+
# to be used for encrypting the build project's build output
|
366
|
+
# artifacts.
|
367
|
+
#
|
368
|
+
# You can specify either the CMK's Amazon Resource Name (ARN) or, if
|
369
|
+
# available, the CMK's alias (using the format `alias/alias-name `).
|
370
|
+
# @return [String]
|
371
|
+
#
|
372
|
+
# @!attribute [rw] tags
|
373
|
+
# A set of tags for this build project.
|
374
|
+
#
|
375
|
+
# These tags are available for use by AWS services that support AWS
|
376
|
+
# CodeBuild build project tags.
|
377
|
+
# @return [Array<Types::Tag>]
|
378
|
+
class CreateProjectInput < Struct.new(
|
379
|
+
:name,
|
380
|
+
:description,
|
381
|
+
:source,
|
382
|
+
:artifacts,
|
383
|
+
:environment,
|
384
|
+
:service_role,
|
385
|
+
:timeout_in_minutes,
|
386
|
+
:encryption_key,
|
387
|
+
:tags)
|
388
|
+
include Aws::Structure
|
389
|
+
end
|
390
|
+
|
391
|
+
# @!attribute [rw] project
|
392
|
+
# Information about the build project that was created.
|
393
|
+
# @return [Types::Project]
|
394
|
+
class CreateProjectOutput < Struct.new(
|
395
|
+
:project)
|
396
|
+
include Aws::Structure
|
397
|
+
end
|
398
|
+
|
399
|
+
# @note When making an API call, pass DeleteProjectInput
|
400
|
+
# data as a hash:
|
401
|
+
#
|
402
|
+
# {
|
403
|
+
# name: "NonEmptyString", # required
|
404
|
+
# }
|
405
|
+
# @!attribute [rw] name
|
406
|
+
# The name of the build project to delete.
|
407
|
+
# @return [String]
|
408
|
+
class DeleteProjectInput < Struct.new(
|
409
|
+
:name)
|
410
|
+
include Aws::Structure
|
411
|
+
end
|
412
|
+
|
413
|
+
class DeleteProjectOutput < Aws::EmptyStructure; end
|
414
|
+
|
415
|
+
# Information about a Docker image that is managed by AWS CodeBuild.
|
416
|
+
# @!attribute [rw] name
|
417
|
+
# The Docker image's name.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] description
|
421
|
+
# The Docker image's description.
|
422
|
+
# @return [String]
|
423
|
+
class EnvironmentImage < Struct.new(
|
424
|
+
:name,
|
425
|
+
:description)
|
426
|
+
include Aws::Structure
|
427
|
+
end
|
428
|
+
|
429
|
+
# A set of Docker images that are related by programming language and
|
430
|
+
# are managed by AWS CodeBuild.
|
431
|
+
# @!attribute [rw] language
|
432
|
+
# The programming language for the related set of Docker images.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] images
|
436
|
+
# The list of Docker images that are related by the specified
|
437
|
+
# programming language.
|
438
|
+
# @return [Array<Types::EnvironmentImage>]
|
439
|
+
class EnvironmentLanguage < Struct.new(
|
440
|
+
:language,
|
441
|
+
:images)
|
442
|
+
include Aws::Structure
|
443
|
+
end
|
444
|
+
|
445
|
+
# A set of Docker images that are related by platform and are managed by
|
446
|
+
# AWS CodeBuild.
|
447
|
+
# @!attribute [rw] platform
|
448
|
+
# The platform's name.
|
449
|
+
# @return [String]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] languages
|
452
|
+
# The list of programming languages that are available for the
|
453
|
+
# specified platform.
|
454
|
+
# @return [Array<Types::EnvironmentLanguage>]
|
455
|
+
class EnvironmentPlatform < Struct.new(
|
456
|
+
:platform,
|
457
|
+
:languages)
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
461
|
+
# Information about an environment variable for a build project or a
|
462
|
+
# build.
|
463
|
+
# @note When making an API call, pass EnvironmentVariable
|
464
|
+
# data as a hash:
|
465
|
+
#
|
466
|
+
# {
|
467
|
+
# name: "NonEmptyString", # required
|
468
|
+
# value: "String", # required
|
469
|
+
# }
|
470
|
+
# @!attribute [rw] name
|
471
|
+
# The environment variable's name or key.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] value
|
475
|
+
# The environment variable's value.
|
476
|
+
# @return [String]
|
477
|
+
class EnvironmentVariable < Struct.new(
|
478
|
+
:name,
|
479
|
+
:value)
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
483
|
+
# @note When making an API call, pass ListBuildsForProjectInput
|
484
|
+
# data as a hash:
|
485
|
+
#
|
486
|
+
# {
|
487
|
+
# project_name: "NonEmptyString", # required
|
488
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
489
|
+
# next_token: "String",
|
490
|
+
# }
|
491
|
+
# @!attribute [rw] project_name
|
492
|
+
# The name of the build project to get a list of build IDs for.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] sort_order
|
496
|
+
# The order to list build IDs. Valid values include:
|
497
|
+
#
|
498
|
+
# * `ASCENDING`\: List the build IDs in ascending order by build ID.
|
499
|
+
#
|
500
|
+
# * `DESCENDING`\: List the build IDs in descending order by build ID.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] next_token
|
504
|
+
# During a previous call, if there are more than 100 items in the
|
505
|
+
# list, only the first 100 items are returned, along with a unique
|
506
|
+
# string called a *next token*. To get the next batch of items in the
|
507
|
+
# list, call this operation again, adding the next token to the call.
|
508
|
+
# To get all of the items in the list, keep calling this operation
|
509
|
+
# with each subsequent next token that is returned, until no more next
|
510
|
+
# tokens are returned.
|
511
|
+
# @return [String]
|
512
|
+
class ListBuildsForProjectInput < Struct.new(
|
513
|
+
:project_name,
|
514
|
+
:sort_order,
|
515
|
+
:next_token)
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
518
|
+
|
519
|
+
# @!attribute [rw] ids
|
520
|
+
# A list of build IDs for the specified build project, with each build
|
521
|
+
# ID representing a single build.
|
522
|
+
# @return [Array<String>]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] next_token
|
525
|
+
# If there are more than 100 items in the list, only the first 100
|
526
|
+
# items are returned, along with a unique string called a *next
|
527
|
+
# token*. To get the next batch of items in the list, call this
|
528
|
+
# operation again, adding the next token to the call.
|
529
|
+
# @return [String]
|
530
|
+
class ListBuildsForProjectOutput < Struct.new(
|
531
|
+
:ids,
|
532
|
+
:next_token)
|
533
|
+
include Aws::Structure
|
534
|
+
end
|
535
|
+
|
536
|
+
# @note When making an API call, pass ListBuildsInput
|
537
|
+
# data as a hash:
|
538
|
+
#
|
539
|
+
# {
|
540
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
541
|
+
# next_token: "String",
|
542
|
+
# }
|
543
|
+
# @!attribute [rw] sort_order
|
544
|
+
# The order to list build IDs. Valid values include:
|
545
|
+
#
|
546
|
+
# * `ASCENDING`\: List the build IDs in ascending order by build ID.
|
547
|
+
#
|
548
|
+
# * `DESCENDING`\: List the build IDs in descending order by build ID.
|
549
|
+
# @return [String]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] next_token
|
552
|
+
# During a previous call, if there are more than 100 items in the
|
553
|
+
# list, only the first 100 items are returned, along with a unique
|
554
|
+
# string called a *next token*. To get the next batch of items in the
|
555
|
+
# list, call this operation again, adding the next token to the call.
|
556
|
+
# To get all of the items in the list, keep calling this operation
|
557
|
+
# with each subsequent next token that is returned, until no more next
|
558
|
+
# tokens are returned.
|
559
|
+
# @return [String]
|
560
|
+
class ListBuildsInput < Struct.new(
|
561
|
+
:sort_order,
|
562
|
+
:next_token)
|
563
|
+
include Aws::Structure
|
564
|
+
end
|
565
|
+
|
566
|
+
# @!attribute [rw] ids
|
567
|
+
# A list of build IDs, with each build ID representing a single build.
|
568
|
+
# @return [Array<String>]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] next_token
|
571
|
+
# If there are more than 100 items in the list, only the first 100
|
572
|
+
# items are returned, along with a unique string called a *next
|
573
|
+
# token*. To get the next batch of items in the list, call this
|
574
|
+
# operation again, adding the next token to the call.
|
575
|
+
# @return [String]
|
576
|
+
class ListBuildsOutput < Struct.new(
|
577
|
+
:ids,
|
578
|
+
:next_token)
|
579
|
+
include Aws::Structure
|
580
|
+
end
|
581
|
+
|
582
|
+
# @api private
|
583
|
+
class ListCuratedEnvironmentImagesInput < Aws::EmptyStructure; end
|
584
|
+
|
585
|
+
# @!attribute [rw] platforms
|
586
|
+
# Information about supported platforms for Docker images that are
|
587
|
+
# managed by AWS CodeBuild.
|
588
|
+
# @return [Array<Types::EnvironmentPlatform>]
|
589
|
+
class ListCuratedEnvironmentImagesOutput < Struct.new(
|
590
|
+
:platforms)
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# @note When making an API call, pass ListProjectsInput
|
595
|
+
# data as a hash:
|
596
|
+
#
|
597
|
+
# {
|
598
|
+
# sort_by: "NAME", # accepts NAME, CREATED_TIME, LAST_MODIFIED_TIME
|
599
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
600
|
+
# next_token: "NonEmptyString",
|
601
|
+
# }
|
602
|
+
# @!attribute [rw] sort_by
|
603
|
+
# The criterion to be used to list build project names. Valid values
|
604
|
+
# include:
|
605
|
+
#
|
606
|
+
# * `CREATED_TIME`\: List the build project names based on when each
|
607
|
+
# build project was created.
|
608
|
+
#
|
609
|
+
# * `LAST_MODIFIED_TIME`\: List the build project names based on when
|
610
|
+
# information about each build project was last changed.
|
611
|
+
#
|
612
|
+
# * `NAME`\: List the build project names based on each build
|
613
|
+
# project's name.
|
614
|
+
#
|
615
|
+
# Use `sortOrder` to specify in what order to list the build project
|
616
|
+
# names based on the preceding criteria.
|
617
|
+
# @return [String]
|
618
|
+
#
|
619
|
+
# @!attribute [rw] sort_order
|
620
|
+
# The order in which to list build projects. Valid values include:
|
621
|
+
#
|
622
|
+
# * `ASCENDING`\: List the build project names in ascending order.
|
623
|
+
#
|
624
|
+
# * `DESCENDING`\: List the build project names in descending order.
|
625
|
+
#
|
626
|
+
# Use `sortBy` to specify the criterion to be used to list build
|
627
|
+
# project names.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] next_token
|
631
|
+
# During a previous call, if there are more than 100 items in the
|
632
|
+
# list, only the first 100 items are returned, along with a unique
|
633
|
+
# string called a *next token*. To get the next batch of items in the
|
634
|
+
# list, call this operation again, adding the next token to the call.
|
635
|
+
# To get all of the items in the list, keep calling this operation
|
636
|
+
# with each subsequent next token that is returned, until no more next
|
637
|
+
# tokens are returned.
|
638
|
+
# @return [String]
|
639
|
+
class ListProjectsInput < Struct.new(
|
640
|
+
:sort_by,
|
641
|
+
:sort_order,
|
642
|
+
:next_token)
|
643
|
+
include Aws::Structure
|
644
|
+
end
|
645
|
+
|
646
|
+
# @!attribute [rw] next_token
|
647
|
+
# If there are more than 100 items in the list, only the first 100
|
648
|
+
# items are returned, along with a unique string called a *next
|
649
|
+
# token*. To get the next batch of items in the list, call this
|
650
|
+
# operation again, adding the next token to the call.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] projects
|
654
|
+
# The list of build project names, with each build project name
|
655
|
+
# representing a single build project.
|
656
|
+
# @return [Array<String>]
|
657
|
+
class ListProjectsOutput < Struct.new(
|
658
|
+
:next_token,
|
659
|
+
:projects)
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# Information about build logs in Amazon CloudWatch Logs.
|
664
|
+
# @!attribute [rw] group_name
|
665
|
+
# The name of the Amazon CloudWatch Logs group for the associated
|
666
|
+
# build logs.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] stream_name
|
670
|
+
# The name of the Amazon CloudWatch Logs stream for the associated
|
671
|
+
# build logs.
|
672
|
+
# @return [String]
|
673
|
+
#
|
674
|
+
# @!attribute [rw] deep_link
|
675
|
+
# The URL to an individual build log in Amazon CloudWatch Logs.
|
676
|
+
# @return [String]
|
677
|
+
class LogsLocation < Struct.new(
|
678
|
+
:group_name,
|
679
|
+
:stream_name,
|
680
|
+
:deep_link)
|
681
|
+
include Aws::Structure
|
682
|
+
end
|
683
|
+
|
684
|
+
# Additional information about a build phase that has an error, which
|
685
|
+
# you can use to help troubleshoot a failed build.
|
686
|
+
# @!attribute [rw] status_code
|
687
|
+
# The status code for the context of the build phase.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] message
|
691
|
+
# An explanation of the build phase's context. This explanation may
|
692
|
+
# include a command ID and an exit code.
|
693
|
+
# @return [String]
|
694
|
+
class PhaseContext < Struct.new(
|
695
|
+
:status_code,
|
696
|
+
:message)
|
697
|
+
include Aws::Structure
|
698
|
+
end
|
699
|
+
|
700
|
+
# Information about a build project.
|
701
|
+
# @!attribute [rw] name
|
702
|
+
# The build project's name.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] arn
|
706
|
+
# The build project's Amazon Resource Name (ARN).
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] description
|
710
|
+
# A meaningful description of the build project.
|
711
|
+
# @return [String]
|
712
|
+
#
|
713
|
+
# @!attribute [rw] source
|
714
|
+
# Information about the build project's build input source code.
|
715
|
+
# @return [Types::ProjectSource]
|
716
|
+
#
|
717
|
+
# @!attribute [rw] artifacts
|
718
|
+
# Information about the build project's build output artifacts.
|
719
|
+
# @return [Types::ProjectArtifacts]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] environment
|
722
|
+
# Information about the build environment for this build project.
|
723
|
+
# @return [Types::ProjectEnvironment]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] service_role
|
726
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
727
|
+
# Management (IAM) role that enables AWS CodeBuild to interact with
|
728
|
+
# dependent AWS services on behalf of the AWS account.
|
729
|
+
# @return [String]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] timeout_in_minutes
|
732
|
+
# How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to
|
733
|
+
# wait to timeout any related build that did not get marked as
|
734
|
+
# completed. The default is 60 minutes.
|
735
|
+
# @return [Integer]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] encryption_key
|
738
|
+
# The AWS Key Management Service (AWS KMS) customer master key (CMK)
|
739
|
+
# to be used for encrypting the build project's build output
|
740
|
+
# artifacts.
|
741
|
+
#
|
742
|
+
# This is expressed either as the CMK's Amazon Resource Name (ARN)
|
743
|
+
# or, if specified, the CMK's alias (using the format
|
744
|
+
# `alias/alias-name `).
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] tags
|
748
|
+
# The tags for this build project.
|
749
|
+
#
|
750
|
+
# These tags are available for use by AWS services that support AWS
|
751
|
+
# CodeBuild build project tags.
|
752
|
+
# @return [Array<Types::Tag>]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] created
|
755
|
+
# When the build project was created, expressed in Unix time format.
|
756
|
+
# @return [Time]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] last_modified
|
759
|
+
# When the build project's settings were last modified, expressed in
|
760
|
+
# Unix time format.
|
761
|
+
# @return [Time]
|
762
|
+
class Project < Struct.new(
|
763
|
+
:name,
|
764
|
+
:arn,
|
765
|
+
:description,
|
766
|
+
:source,
|
767
|
+
:artifacts,
|
768
|
+
:environment,
|
769
|
+
:service_role,
|
770
|
+
:timeout_in_minutes,
|
771
|
+
:encryption_key,
|
772
|
+
:tags,
|
773
|
+
:created,
|
774
|
+
:last_modified)
|
775
|
+
include Aws::Structure
|
776
|
+
end
|
777
|
+
|
778
|
+
# Information about the build project's build output artifacts.
|
779
|
+
# @note When making an API call, pass ProjectArtifacts
|
780
|
+
# data as a hash:
|
781
|
+
#
|
782
|
+
# {
|
783
|
+
# type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
|
784
|
+
# location: "String",
|
785
|
+
# path: "String",
|
786
|
+
# namespace_type: "NONE", # accepts NONE, BUILD_ID
|
787
|
+
# name: "String",
|
788
|
+
# packaging: "NONE", # accepts NONE, ZIP
|
789
|
+
# }
|
790
|
+
# @!attribute [rw] type
|
791
|
+
# The build output artifact's type. Valid values include:
|
792
|
+
#
|
793
|
+
# * `CODEPIPELINE`\: The build project with have build output
|
794
|
+
# generated through AWS CodePipeline.
|
795
|
+
#
|
796
|
+
# * `NO_ARTIFACTS`\: The build project will not produce any build
|
797
|
+
# output.
|
798
|
+
#
|
799
|
+
# * `S3`\: The build project will store build output in Amazon Simple
|
800
|
+
# Storage Service (Amazon S3).
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] location
|
804
|
+
# Information about the build output artifact location, as follows:
|
805
|
+
#
|
806
|
+
# * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
|
807
|
+
# ignore this value if specified. This is because AWS CodePipeline
|
808
|
+
# manages its build output locations instead of AWS CodeBuild.
|
809
|
+
#
|
810
|
+
# * If `type` is set to `NO_ARTIFACTS`, then this value will be
|
811
|
+
# ignored if specified, because no build output will be produced.
|
812
|
+
#
|
813
|
+
# * If `type` is set to `S3`, this is the name of the output bucket.
|
814
|
+
# If `path` is not also specified, then `location` can also specify
|
815
|
+
# the path of the output artifact in the output bucket.
|
816
|
+
# @return [String]
|
817
|
+
#
|
818
|
+
# @!attribute [rw] path
|
819
|
+
# Along with `namespaceType` and `name`, the pattern that AWS
|
820
|
+
# CodeBuild will use to name and store the output artifact, as
|
821
|
+
# follows:
|
822
|
+
#
|
823
|
+
# * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
|
824
|
+
# ignore this value if specified. This is because AWS CodePipeline
|
825
|
+
# manages its build output names instead of AWS CodeBuild.
|
826
|
+
#
|
827
|
+
# * If `type` is set to `NO_ARTIFACTS`, then this value will be
|
828
|
+
# ignored if specified, because no build output will be produced.
|
829
|
+
#
|
830
|
+
# * If `type` is set to `S3`, this is the path to the output artifact.
|
831
|
+
# If `path` is not specified, then `path` will not be used.
|
832
|
+
#
|
833
|
+
# For example, if `path` is set to `MyArtifacts`, `namespaceType` is
|
834
|
+
# set to `NONE`, and `name` is set to `MyArtifact.zip`, then the
|
835
|
+
# output artifact would be stored in the output bucket at
|
836
|
+
# `MyArtifacts/MyArtifact.zip`.
|
837
|
+
# @return [String]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] namespace_type
|
840
|
+
# Along with `path` and `name`, the pattern that AWS CodeBuild will
|
841
|
+
# use to determine the name and location to store the output artifact,
|
842
|
+
# as follows:
|
843
|
+
#
|
844
|
+
# * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
|
845
|
+
# ignore this value if specified. This is because AWS CodePipeline
|
846
|
+
# manages its build output names instead of AWS CodeBuild.
|
847
|
+
#
|
848
|
+
# * If `type` is set to `NO_ARTIFACTS`, then this value will be
|
849
|
+
# ignored if specified, because no build output will be produced.
|
850
|
+
#
|
851
|
+
# * If `type` is set to `S3`, then valid values include:
|
852
|
+
#
|
853
|
+
# * `BUILD_ID`\: Include the build ID in the location of the build
|
854
|
+
# output artifact.
|
855
|
+
#
|
856
|
+
# * `NONE`\: Do not include the build ID. This is the default if
|
857
|
+
# `namespaceType` is not specified.
|
858
|
+
#
|
859
|
+
# For example, if `path` is set to `MyArtifacts`, `namespaceType` is
|
860
|
+
# set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, then the
|
861
|
+
# output artifact would be stored in
|
862
|
+
# `MyArtifacts/build-ID/MyArtifact.zip`.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @!attribute [rw] name
|
866
|
+
# Along with `path` and `namespaceType`, the pattern that AWS
|
867
|
+
# CodeBuild will use to name and store the output artifact, as
|
868
|
+
# follows:
|
869
|
+
#
|
870
|
+
# * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
|
871
|
+
# ignore this value if specified. This is because AWS CodePipeline
|
872
|
+
# manages its build output names instead of AWS CodeBuild.
|
873
|
+
#
|
874
|
+
# * If `type` is set to `NO_ARTIFACTS`, then this value will be
|
875
|
+
# ignored if specified, because no build output will be produced.
|
876
|
+
#
|
877
|
+
# * If `type` is set to `S3`, this is the name of the output artifact
|
878
|
+
# object.
|
879
|
+
#
|
880
|
+
# For example, if `path` is set to `MyArtifacts`, `namespaceType` is
|
881
|
+
# set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, then the
|
882
|
+
# output artifact would be stored in
|
883
|
+
# `MyArtifacts/build-ID/MyArtifact.zip`.
|
884
|
+
# @return [String]
|
885
|
+
#
|
886
|
+
# @!attribute [rw] packaging
|
887
|
+
# The type of build output artifact to create, as follows:
|
888
|
+
#
|
889
|
+
# * If `type` is set to `CODEPIPELINE`, then AWS CodePipeline will
|
890
|
+
# ignore this value if specified. This is because AWS CodePipeline
|
891
|
+
# manages its build output artifacts instead of AWS CodeBuild.
|
892
|
+
#
|
893
|
+
# * If `type` is set to `NO_ARTIFACTS`, then this value will be
|
894
|
+
# ignored if specified, because no build output will be produced.
|
895
|
+
#
|
896
|
+
# * If `type` is set to `S3`, valid values include:
|
897
|
+
#
|
898
|
+
# * `NONE`\: AWS CodeBuild will create in the output bucket a folder
|
899
|
+
# containing the build output. This is the default if `packaging`
|
900
|
+
# is not specified.
|
901
|
+
#
|
902
|
+
# * `ZIP`\: AWS CodeBuild will create in the output bucket a ZIP
|
903
|
+
# file containing the build output.
|
904
|
+
# @return [String]
|
905
|
+
class ProjectArtifacts < Struct.new(
|
906
|
+
:type,
|
907
|
+
:location,
|
908
|
+
:path,
|
909
|
+
:namespace_type,
|
910
|
+
:name,
|
911
|
+
:packaging)
|
912
|
+
include Aws::Structure
|
913
|
+
end
|
914
|
+
|
915
|
+
# Information about the build project's build environment.
|
916
|
+
# @note When making an API call, pass ProjectEnvironment
|
917
|
+
# data as a hash:
|
918
|
+
#
|
919
|
+
# {
|
920
|
+
# type: "LINUX_CONTAINER", # required, accepts LINUX_CONTAINER
|
921
|
+
# image: "NonEmptyString", # required
|
922
|
+
# compute_type: "BUILD_GENERAL1_SMALL", # required, accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
|
923
|
+
# environment_variables: [
|
924
|
+
# {
|
925
|
+
# name: "NonEmptyString", # required
|
926
|
+
# value: "String", # required
|
927
|
+
# },
|
928
|
+
# ],
|
929
|
+
# }
|
930
|
+
# @!attribute [rw] type
|
931
|
+
# The type of build environment to use for related builds.
|
932
|
+
#
|
933
|
+
# The only valid value is `LINUX_CONTAINER`, which represents a
|
934
|
+
# Linux-based build environment.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] image
|
938
|
+
# The ID of the Docker image to use for this build project.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] compute_type
|
942
|
+
# Information about the compute resources the build project will use.
|
943
|
+
# Available values include:
|
944
|
+
#
|
945
|
+
# * `BUILD_GENERAL1_SMALL`\: Use up to 3 GB memory and 2 vCPUs for
|
946
|
+
# builds.
|
947
|
+
#
|
948
|
+
# * `BUILD_GENERAL1_MEDIUM`\: Use up to 7 GB memory and 4 vCPUs for
|
949
|
+
# builds.
|
950
|
+
#
|
951
|
+
# * `BUILD_GENERAL1_LARGE`\: Use up to 15 GB memory and 8 vCPUs for
|
952
|
+
# builds.
|
953
|
+
# @return [String]
|
954
|
+
#
|
955
|
+
# @!attribute [rw] environment_variables
|
956
|
+
# A set of environment variables to make available to builds for this
|
957
|
+
# build project.
|
958
|
+
# @return [Array<Types::EnvironmentVariable>]
|
959
|
+
class ProjectEnvironment < Struct.new(
|
960
|
+
:type,
|
961
|
+
:image,
|
962
|
+
:compute_type,
|
963
|
+
:environment_variables)
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# Information about the build project's build input source code.
|
968
|
+
# @note When making an API call, pass ProjectSource
|
969
|
+
# data as a hash:
|
970
|
+
#
|
971
|
+
# {
|
972
|
+
# type: "CODECOMMIT", # required, accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3
|
973
|
+
# location: "String",
|
974
|
+
# buildspec: "String",
|
975
|
+
# auth: {
|
976
|
+
# type: "OAUTH", # required, accepts OAUTH
|
977
|
+
# resource: "String",
|
978
|
+
# },
|
979
|
+
# }
|
980
|
+
# @!attribute [rw] type
|
981
|
+
# The type of repository that contains the source code to be built.
|
982
|
+
# Valid values include:
|
983
|
+
#
|
984
|
+
# * `CODECOMMIT`\: The source code is in an AWS CodeCommit repository.
|
985
|
+
#
|
986
|
+
# * `CODEPIPELINE`\: The source code settings are specified in the
|
987
|
+
# source action of a pipeline in AWS CodePipeline.
|
988
|
+
#
|
989
|
+
# * `GITHUB`\: The source code is in a GitHub repository.
|
990
|
+
#
|
991
|
+
# * `S3`\: The source code is in an Amazon Simple Storage Service
|
992
|
+
# (Amazon S3) input bucket.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] location
|
996
|
+
# Information about the location of the source code to be built. Valid
|
997
|
+
# values include:
|
998
|
+
#
|
999
|
+
# * For source code settings that are specified in the source action
|
1000
|
+
# of a pipeline in AWS CodePipeline, `location` should not be
|
1001
|
+
# specified. If it is specified, AWS CodePipeline will ignore it.
|
1002
|
+
# This is because AWS CodePipeline uses the settings in a
|
1003
|
+
# pipeline's source action instead of this value.
|
1004
|
+
#
|
1005
|
+
# * For source code in an AWS CodeCommit repository, the HTTPS clone
|
1006
|
+
# URL to the repository that contains the source code and the build
|
1007
|
+
# spec (for example,
|
1008
|
+
# `https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name
|
1009
|
+
# `).
|
1010
|
+
#
|
1011
|
+
# * For source code in an Amazon Simple Storage Service (Amazon S3)
|
1012
|
+
# input bucket, the path to the ZIP file that contains the source
|
1013
|
+
# code (for example, ` bucket-name/path/to/object-name.zip`)
|
1014
|
+
#
|
1015
|
+
# * For source code in a GitHub repository, the HTTPS clone URL,
|
1016
|
+
# including the user name and personal access token, to the
|
1017
|
+
# repository that contains the source code and the build spec (for
|
1018
|
+
# example,
|
1019
|
+
# `https://login-user-name:personal-access-token@github.com/repo-owner-name/repo-name.git`).
|
1020
|
+
# For more information, see [Creating an Access Token for
|
1021
|
+
# Command-Line Use][1] on the GitHub Help website.
|
1022
|
+
#
|
1023
|
+
#
|
1024
|
+
#
|
1025
|
+
# [1]: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] buildspec
|
1029
|
+
# The build spec declaration to use for this build project's related
|
1030
|
+
# builds.
|
1031
|
+
#
|
1032
|
+
# If this value is not specified, a build spec must be included along
|
1033
|
+
# with the source code to be built.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] auth
|
1037
|
+
# Information about the authorization settings for AWS CodeBuild to
|
1038
|
+
# access the source code to be built.
|
1039
|
+
#
|
1040
|
+
# This information is only for the AWS CodeBuild console's use. Your
|
1041
|
+
# code should not get or set this information directly.
|
1042
|
+
# @return [Types::SourceAuth]
|
1043
|
+
class ProjectSource < Struct.new(
|
1044
|
+
:type,
|
1045
|
+
:location,
|
1046
|
+
:buildspec,
|
1047
|
+
:auth)
|
1048
|
+
include Aws::Structure
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# Information about the authorization settings for AWS CodeBuild to
|
1052
|
+
# access the source code to be built.
|
1053
|
+
#
|
1054
|
+
# This information is only for the AWS CodeBuild console's use. Your
|
1055
|
+
# code should not get or set this information directly.
|
1056
|
+
# @note When making an API call, pass SourceAuth
|
1057
|
+
# data as a hash:
|
1058
|
+
#
|
1059
|
+
# {
|
1060
|
+
# type: "OAUTH", # required, accepts OAUTH
|
1061
|
+
# resource: "String",
|
1062
|
+
# }
|
1063
|
+
# @!attribute [rw] type
|
1064
|
+
# The authorization type to use. The only valid value is `OAUTH`,
|
1065
|
+
# which represents the OAuth authorization type.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] resource
|
1069
|
+
# The resource value that applies to the specified authorization type.
|
1070
|
+
# @return [String]
|
1071
|
+
class SourceAuth < Struct.new(
|
1072
|
+
:type,
|
1073
|
+
:resource)
|
1074
|
+
include Aws::Structure
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# @note When making an API call, pass StartBuildInput
|
1078
|
+
# data as a hash:
|
1079
|
+
#
|
1080
|
+
# {
|
1081
|
+
# project_name: "NonEmptyString", # required
|
1082
|
+
# source_version: "String",
|
1083
|
+
# artifacts_override: {
|
1084
|
+
# type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
|
1085
|
+
# location: "String",
|
1086
|
+
# path: "String",
|
1087
|
+
# namespace_type: "NONE", # accepts NONE, BUILD_ID
|
1088
|
+
# name: "String",
|
1089
|
+
# packaging: "NONE", # accepts NONE, ZIP
|
1090
|
+
# },
|
1091
|
+
# environment_variables_override: [
|
1092
|
+
# {
|
1093
|
+
# name: "NonEmptyString", # required
|
1094
|
+
# value: "String", # required
|
1095
|
+
# },
|
1096
|
+
# ],
|
1097
|
+
# buildspec_override: "String",
|
1098
|
+
# timeout_in_minutes_override: 1,
|
1099
|
+
# }
|
1100
|
+
# @!attribute [rw] project_name
|
1101
|
+
# The name of the build project to start running a build.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] source_version
|
1105
|
+
# A version of the build input to be built, for this build only. If
|
1106
|
+
# not specified, the latest version will be used. If specified, must
|
1107
|
+
# be one of:
|
1108
|
+
#
|
1109
|
+
# * For AWS CodeCommit or GitHub: the commit ID to use.
|
1110
|
+
#
|
1111
|
+
# * For Amazon Simple Storage Service (Amazon S3): the version ID of
|
1112
|
+
# the object representing the build input ZIP file to use.
|
1113
|
+
# @return [String]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] artifacts_override
|
1116
|
+
# Build output artifact settings that override, for this build only,
|
1117
|
+
# the latest ones already defined in the corresponding build project.
|
1118
|
+
# @return [Types::ProjectArtifacts]
|
1119
|
+
#
|
1120
|
+
# @!attribute [rw] environment_variables_override
|
1121
|
+
# A set of environment variables that overrides, for this build only,
|
1122
|
+
# the latest ones already defined in the corresponding build project.
|
1123
|
+
# @return [Array<Types::EnvironmentVariable>]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] buildspec_override
|
1126
|
+
# A build spec declaration that overrides, for this build only, the
|
1127
|
+
# latest one already defined in the corresponding build project.
|
1128
|
+
# @return [String]
|
1129
|
+
#
|
1130
|
+
# @!attribute [rw] timeout_in_minutes_override
|
1131
|
+
# The number of build timeout minutes, from 5 to 480 (8 hours) that
|
1132
|
+
# overrides, for this build only, the latest setting already defined
|
1133
|
+
# in the corresponding build project.
|
1134
|
+
# @return [Integer]
|
1135
|
+
class StartBuildInput < Struct.new(
|
1136
|
+
:project_name,
|
1137
|
+
:source_version,
|
1138
|
+
:artifacts_override,
|
1139
|
+
:environment_variables_override,
|
1140
|
+
:buildspec_override,
|
1141
|
+
:timeout_in_minutes_override)
|
1142
|
+
include Aws::Structure
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# @!attribute [rw] build
|
1146
|
+
# Information about the build to be run.
|
1147
|
+
# @return [Types::Build]
|
1148
|
+
class StartBuildOutput < Struct.new(
|
1149
|
+
:build)
|
1150
|
+
include Aws::Structure
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# @note When making an API call, pass StopBuildInput
|
1154
|
+
# data as a hash:
|
1155
|
+
#
|
1156
|
+
# {
|
1157
|
+
# id: "NonEmptyString", # required
|
1158
|
+
# }
|
1159
|
+
# @!attribute [rw] id
|
1160
|
+
# The ID of the build to attempt to stop running.
|
1161
|
+
# @return [String]
|
1162
|
+
class StopBuildInput < Struct.new(
|
1163
|
+
:id)
|
1164
|
+
include Aws::Structure
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# @!attribute [rw] build
|
1168
|
+
# Information about the build that was attempted to be stopped.
|
1169
|
+
# @return [Types::Build]
|
1170
|
+
class StopBuildOutput < Struct.new(
|
1171
|
+
:build)
|
1172
|
+
include Aws::Structure
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
# A tag, consisting of a key and a value.
|
1176
|
+
#
|
1177
|
+
# This tag is available for use by AWS services that support tags in AWS
|
1178
|
+
# CodeBuild.
|
1179
|
+
# @note When making an API call, pass Tag
|
1180
|
+
# data as a hash:
|
1181
|
+
#
|
1182
|
+
# {
|
1183
|
+
# key: "KeyInput",
|
1184
|
+
# value: "ValueInput",
|
1185
|
+
# }
|
1186
|
+
# @!attribute [rw] key
|
1187
|
+
# The tag's key.
|
1188
|
+
# @return [String]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] value
|
1191
|
+
# The tag's value.
|
1192
|
+
# @return [String]
|
1193
|
+
class Tag < Struct.new(
|
1194
|
+
:key,
|
1195
|
+
:value)
|
1196
|
+
include Aws::Structure
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# @note When making an API call, pass UpdateProjectInput
|
1200
|
+
# data as a hash:
|
1201
|
+
#
|
1202
|
+
# {
|
1203
|
+
# name: "NonEmptyString", # required
|
1204
|
+
# description: "ProjectDescription",
|
1205
|
+
# source: {
|
1206
|
+
# type: "CODECOMMIT", # required, accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3
|
1207
|
+
# location: "String",
|
1208
|
+
# buildspec: "String",
|
1209
|
+
# auth: {
|
1210
|
+
# type: "OAUTH", # required, accepts OAUTH
|
1211
|
+
# resource: "String",
|
1212
|
+
# },
|
1213
|
+
# },
|
1214
|
+
# artifacts: {
|
1215
|
+
# type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
|
1216
|
+
# location: "String",
|
1217
|
+
# path: "String",
|
1218
|
+
# namespace_type: "NONE", # accepts NONE, BUILD_ID
|
1219
|
+
# name: "String",
|
1220
|
+
# packaging: "NONE", # accepts NONE, ZIP
|
1221
|
+
# },
|
1222
|
+
# environment: {
|
1223
|
+
# type: "LINUX_CONTAINER", # required, accepts LINUX_CONTAINER
|
1224
|
+
# image: "NonEmptyString", # required
|
1225
|
+
# compute_type: "BUILD_GENERAL1_SMALL", # required, accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
|
1226
|
+
# environment_variables: [
|
1227
|
+
# {
|
1228
|
+
# name: "NonEmptyString", # required
|
1229
|
+
# value: "String", # required
|
1230
|
+
# },
|
1231
|
+
# ],
|
1232
|
+
# },
|
1233
|
+
# service_role: "NonEmptyString",
|
1234
|
+
# timeout_in_minutes: 1,
|
1235
|
+
# encryption_key: "NonEmptyString",
|
1236
|
+
# tags: [
|
1237
|
+
# {
|
1238
|
+
# key: "KeyInput",
|
1239
|
+
# value: "ValueInput",
|
1240
|
+
# },
|
1241
|
+
# ],
|
1242
|
+
# }
|
1243
|
+
# @!attribute [rw] name
|
1244
|
+
# The name of the existing build project to change settings.
|
1245
|
+
#
|
1246
|
+
# <note markdown="1"> You cannot change an existing build project's name.
|
1247
|
+
#
|
1248
|
+
# </note>
|
1249
|
+
# @return [String]
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] description
|
1252
|
+
# A new or replacement description of the build project.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] source
|
1256
|
+
# Information to be changed about the build project's build input
|
1257
|
+
# source code.
|
1258
|
+
# @return [Types::ProjectSource]
|
1259
|
+
#
|
1260
|
+
# @!attribute [rw] artifacts
|
1261
|
+
# Information to be changed about the build project's build output
|
1262
|
+
# artifacts.
|
1263
|
+
# @return [Types::ProjectArtifacts]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] environment
|
1266
|
+
# Information to be changed about the build project's build
|
1267
|
+
# environment.
|
1268
|
+
# @return [Types::ProjectEnvironment]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] service_role
|
1271
|
+
# The replacement Amazon Resource Name (ARN) of the AWS Identity and
|
1272
|
+
# Access Management (IAM) role that enables AWS CodeBuild to interact
|
1273
|
+
# with dependent AWS services on behalf of the AWS account.
|
1274
|
+
# @return [String]
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] timeout_in_minutes
|
1277
|
+
# The replacement value in minutes, from 5 to 480 (8 hours), for AWS
|
1278
|
+
# CodeBuild to wait to timeout any related build that did not get
|
1279
|
+
# marked as completed.
|
1280
|
+
# @return [Integer]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] encryption_key
|
1283
|
+
# The replacement AWS Key Management Service (AWS KMS) customer master
|
1284
|
+
# key (CMK) to be used for encrypting the build project's build
|
1285
|
+
# output artifacts.
|
1286
|
+
#
|
1287
|
+
# You can specify either the CMK's Amazon Resource Name (ARN) or, if
|
1288
|
+
# available, the CMK's alias (using the format `alias/alias-name `).
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] tags
|
1292
|
+
# The replacement set of tags for this build project.
|
1293
|
+
#
|
1294
|
+
# These tags are available for use by AWS services that support AWS
|
1295
|
+
# CodeBuild build project tags.
|
1296
|
+
# @return [Array<Types::Tag>]
|
1297
|
+
class UpdateProjectInput < Struct.new(
|
1298
|
+
:name,
|
1299
|
+
:description,
|
1300
|
+
:source,
|
1301
|
+
:artifacts,
|
1302
|
+
:environment,
|
1303
|
+
:service_role,
|
1304
|
+
:timeout_in_minutes,
|
1305
|
+
:encryption_key,
|
1306
|
+
:tags)
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
# @!attribute [rw] project
|
1311
|
+
# Information about the build project that was changed.
|
1312
|
+
# @return [Types::Project]
|
1313
|
+
class UpdateProjectOutput < Struct.new(
|
1314
|
+
:project)
|
1315
|
+
include Aws::Structure
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
end
|
1319
|
+
end
|
1320
|
+
end
|