blib/lib/Paws/CodeBuild/StartBuild.pm untested

filter: Statementstmt 0.0% 0 / 71 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 73 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CodeBuild::StartBuild;
3 use Moose;
4 has ArtifactsOverride => (is => 'ro', isa => 'Paws::CodeBuild::ProjectArtifacts', traits => ['NameInRequest'], request_name => 'artifactsOverride' );
5 has BuildspecOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'buildspecOverride' );
6 has BuildStatusConfigOverride => (is => 'ro', isa => 'Paws::CodeBuild::BuildStatusConfig', traits => ['NameInRequest'], request_name => 'buildStatusConfigOverride' );
7 has CacheOverride => (is => 'ro', isa => 'Paws::CodeBuild::ProjectCache', traits => ['NameInRequest'], request_name => 'cacheOverride' );
8 has CertificateOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateOverride' );
9 has ComputeTypeOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'computeTypeOverride' );
10 has DebugSessionEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'debugSessionEnabled' );
11 has EncryptionKeyOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'encryptionKeyOverride' );
12 has EnvironmentTypeOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'environmentTypeOverride' );
13 has EnvironmentVariablesOverride => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::EnvironmentVariable]', traits => ['NameInRequest'], request_name => 'environmentVariablesOverride' );
14 has GitCloneDepthOverride => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'gitCloneDepthOverride' );
15 has GitSubmodulesConfigOverride => (is => 'ro', isa => 'Paws::CodeBuild::GitSubmodulesConfig', traits => ['NameInRequest'], request_name => 'gitSubmodulesConfigOverride' );
16 has IdempotencyToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'idempotencyToken' );
17 has ImageOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'imageOverride' );
18 has ImagePullCredentialsTypeOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'imagePullCredentialsTypeOverride' );
19 has InsecureSslOverride => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'insecureSslOverride' );
20 has LogsConfigOverride => (is => 'ro', isa => 'Paws::CodeBuild::LogsConfig', traits => ['NameInRequest'], request_name => 'logsConfigOverride' );
21 has PrivilegedModeOverride => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'privilegedModeOverride' );
22 has ProjectName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'projectName' , required => 1);
23 has QueuedTimeoutInMinutesOverride => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'queuedTimeoutInMinutesOverride' );
24 has RegistryCredentialOverride => (is => 'ro', isa => 'Paws::CodeBuild::RegistryCredential', traits => ['NameInRequest'], request_name => 'registryCredentialOverride' );
25 has ReportBuildStatusOverride => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'reportBuildStatusOverride' );
26 has SecondaryArtifactsOverride => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectArtifacts]', traits => ['NameInRequest'], request_name => 'secondaryArtifactsOverride' );
27 has SecondarySourcesOverride => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSource]', traits => ['NameInRequest'], request_name => 'secondarySourcesOverride' );
28 has SecondarySourcesVersionOverride => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSourceVersion]', traits => ['NameInRequest'], request_name => 'secondarySourcesVersionOverride' );
29 has ServiceRoleOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'serviceRoleOverride' );
30 has SourceAuthOverride => (is => 'ro', isa => 'Paws::CodeBuild::SourceAuth', traits => ['NameInRequest'], request_name => 'sourceAuthOverride' );
31 has SourceLocationOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sourceLocationOverride' );
32 has SourceTypeOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sourceTypeOverride' );
33 has SourceVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sourceVersion' );
34 has TimeoutInMinutesOverride => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'timeoutInMinutesOverride' );
35  
36 use MooseX::ClassAttribute;
37  
38 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartBuild');
39 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeBuild::StartBuildOutput');
40 class_has _result_key => (isa => 'Str', is => 'ro');
41 1;
42  
43 ### main pod documentation begin ###
44  
45 =head1 NAME
46  
47 Paws::CodeBuild::StartBuild - Arguments for method StartBuild on L<Paws::CodeBuild>
48  
49 =head1 DESCRIPTION
50  
51 This class represents the parameters used for calling the method StartBuild on the
52 L<AWS CodeBuild|Paws::CodeBuild> service. Use the attributes of this class
53 as arguments to method StartBuild.
54  
55 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartBuild.
56  
57 =head1 SYNOPSIS
58  
59 my $codebuild = Paws->service('CodeBuild');
60 my $StartBuildOutput = $codebuild->StartBuild(
61 ProjectName => 'MyNonEmptyString',
62 ArtifactsOverride => {
63 Type => 'CODEPIPELINE', # values: CODEPIPELINE, S3, NO_ARTIFACTS
64 ArtifactIdentifier => 'MyString', # OPTIONAL
65 EncryptionDisabled => 1, # OPTIONAL
66 Location => 'MyString', # OPTIONAL
67 Name => 'MyString', # OPTIONAL
68 NamespaceType => 'NONE', # values: NONE, BUILD_ID; OPTIONAL
69 OverrideArtifactName => 1, # OPTIONAL
70 Packaging => 'NONE', # values: NONE, ZIP; OPTIONAL
71 Path => 'MyString', # OPTIONAL
72 }, # OPTIONAL
73 BuildStatusConfigOverride => {
74 Context => 'MyString', # OPTIONAL
75 TargetUrl => 'MyString', # OPTIONAL
76 }, # OPTIONAL
77 BuildspecOverride => 'MyString', # OPTIONAL
78 CacheOverride => {
79 Type => 'NO_CACHE', # values: NO_CACHE, S3, LOCAL
80 Location => 'MyString', # OPTIONAL
81 Modes => [
82 'LOCAL_DOCKER_LAYER_CACHE',
83 ... # values: LOCAL_DOCKER_LAYER_CACHE, LOCAL_SOURCE_CACHE, LOCAL_CUSTOM_CACHE
84 ], # OPTIONAL
85 }, # OPTIONAL
86 CertificateOverride => 'MyString', # OPTIONAL
87 ComputeTypeOverride => 'BUILD_GENERAL1_SMALL', # OPTIONAL
88 DebugSessionEnabled => 1, # OPTIONAL
89 EncryptionKeyOverride => 'MyNonEmptyString', # OPTIONAL
90 EnvironmentTypeOverride => 'WINDOWS_CONTAINER', # OPTIONAL
91 EnvironmentVariablesOverride => [
92 {
93 Name => 'MyNonEmptyString', # min: 1
94 Value => 'MyString', # OPTIONAL
95 Type => 'PLAINTEXT'
96 , # values: PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER; OPTIONAL
97 },
98 ...
99 ], # OPTIONAL
100 GitCloneDepthOverride => 1, # OPTIONAL
101 GitSubmodulesConfigOverride => {
102 FetchSubmodules => 1, # OPTIONAL
103  
104 }, # OPTIONAL
105 IdempotencyToken => 'MyString', # OPTIONAL
106 ImageOverride => 'MyNonEmptyString', # OPTIONAL
107 ImagePullCredentialsTypeOverride => 'CODEBUILD', # OPTIONAL
108 InsecureSslOverride => 1, # OPTIONAL
109 LogsConfigOverride => {
110 CloudWatchLogs => {
111 Status => 'ENABLED', # values: ENABLED, DISABLED
112 GroupName => 'MyString', # OPTIONAL
113 StreamName => 'MyString', # OPTIONAL
114 }, # OPTIONAL
115 S3Logs => {
116 Status => 'ENABLED', # values: ENABLED, DISABLED
117 EncryptionDisabled => 1, # OPTIONAL
118 Location => 'MyString', # OPTIONAL
119 }, # OPTIONAL
120 }, # OPTIONAL
121 PrivilegedModeOverride => 1, # OPTIONAL
122 QueuedTimeoutInMinutesOverride => 1, # OPTIONAL
123 RegistryCredentialOverride => {
124 Credential => 'MyNonEmptyString', # min: 1
125 CredentialProvider => 'SECRETS_MANAGER', # values: SECRETS_MANAGER
126  
127 }, # OPTIONAL
128 ReportBuildStatusOverride => 1, # OPTIONAL
129 SecondaryArtifactsOverride => [
130 {
131 Type => 'CODEPIPELINE', # values: CODEPIPELINE, S3, NO_ARTIFACTS
132 ArtifactIdentifier => 'MyString', # OPTIONAL
133 EncryptionDisabled => 1, # OPTIONAL
134 Location => 'MyString', # OPTIONAL
135 Name => 'MyString', # OPTIONAL
136 NamespaceType => 'NONE', # values: NONE, BUILD_ID; OPTIONAL
137 OverrideArtifactName => 1, # OPTIONAL
138 Packaging => 'NONE', # values: NONE, ZIP; OPTIONAL
139 Path => 'MyString', # OPTIONAL
140 },
141 ...
142 ], # OPTIONAL
143 SecondarySourcesOverride => [
144 {
145 Type => 'CODECOMMIT'
146 , # values: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE, NO_SOURCE
147 Auth => {
148 Type => 'OAUTH', # values: OAUTH
149 Resource => 'MyString', # OPTIONAL
150 }, # OPTIONAL
151 BuildStatusConfig => {
152 Context => 'MyString', # OPTIONAL
153 TargetUrl => 'MyString', # OPTIONAL
154 },
155 Buildspec => 'MyString', # OPTIONAL
156 GitCloneDepth => 1,
157 GitSubmodulesConfig => {
158 FetchSubmodules => 1, # OPTIONAL
159  
160 },
161 InsecureSsl => 1, # OPTIONAL
162 Location => 'MyString', # OPTIONAL
163 ReportBuildStatus => 1, # OPTIONAL
164 SourceIdentifier => 'MyString', # OPTIONAL
165 },
166 ...
167 ], # OPTIONAL
168 SecondarySourcesVersionOverride => [
169 {
170 SourceIdentifier => 'MyString', # OPTIONAL
171 SourceVersion => 'MyString', # OPTIONAL
172  
173 },
174 ...
175 ], # OPTIONAL
176 ServiceRoleOverride => 'MyNonEmptyString', # OPTIONAL
177 SourceAuthOverride => {
178 Type => 'OAUTH', # values: OAUTH
179 Resource => 'MyString', # OPTIONAL
180 }, # OPTIONAL
181 SourceLocationOverride => 'MyString', # OPTIONAL
182 SourceTypeOverride => 'CODECOMMIT', # OPTIONAL
183 SourceVersion => 'MyString', # OPTIONAL
184 TimeoutInMinutesOverride => 1, # OPTIONAL
185 );
186  
187 # Results:
188 my $Build = $StartBuildOutput->Build;
189  
190 # Returns a L<Paws::CodeBuild::StartBuildOutput> object.
191  
192 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
193 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codebuild/StartBuild>
194  
195 =head1 ATTRIBUTES
196  
197  
198 =head2 ArtifactsOverride => L<Paws::CodeBuild::ProjectArtifacts>
199  
200 Build output artifact settings that override, for this build only, the
201 latest ones already defined in the build project.
202  
203  
204  
205 =head2 BuildspecOverride => Str
206  
207 A buildspec file declaration that overrides, for this build only, the
208 latest one already defined in the build project.
209  
210 If this value is set, it can be either an inline buildspec definition,
211 the path to an alternate buildspec file relative to the value of the
212 built-in C<CODEBUILD_SRC_DIR> environment variable, or the path to an
213 S3 bucket. The bucket must be in the same Region as the build project.
214 Specify the buildspec file using its ARN (for example,
215 C<arn:aws:s3:::my-codebuild-sample2/buildspec.yml>). If this value is
216 not provided or is set to an empty string, the source code must contain
217 a buildspec file in its root directory. For more information, see
218 Buildspec File Name and Storage Location
219 (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage).
220  
221  
222  
223 =head2 BuildStatusConfigOverride => L<Paws::CodeBuild::BuildStatusConfig>
224  
225 Contains information that defines how the build project reports the
226 build status to the source provider. This option is only used when the
227 source provider is C<GITHUB>, C<GITHUB_ENTERPRISE>, or C<BITBUCKET>.
228  
229  
230  
231 =head2 CacheOverride => L<Paws::CodeBuild::ProjectCache>
232  
233 A ProjectCache object specified for this build that overrides the one
234 defined in the build project.
235  
236  
237  
238 =head2 CertificateOverride => Str
239  
240 The name of a certificate for this build that overrides the one
241 specified in the build project.
242  
243  
244  
245 =head2 ComputeTypeOverride => Str
246  
247 The name of a compute type for this build that overrides the one
248 specified in the build project.
249  
250 Valid values are: C<"BUILD_GENERAL1_SMALL">, C<"BUILD_GENERAL1_MEDIUM">, C<"BUILD_GENERAL1_LARGE">, C<"BUILD_GENERAL1_2XLARGE">
251  
252 =head2 DebugSessionEnabled => Bool
253  
254 Specifies if session debugging is enabled for this build. For more
255 information, see Viewing a running build in Session Manager
256 (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html).
257  
258  
259  
260 =head2 EncryptionKeyOverride => Str
261  
262 The Key Management Service customer master key (CMK) that overrides the
263 one specified in the build project. The CMK key encrypts the build
264 output artifacts.
265  
266 You can use a cross-account KMS key to encrypt the build output
267 artifacts if your service role has permission to that key.
268  
269 You can specify either the Amazon Resource Name (ARN) of the CMK or, if
270 available, the CMK's alias (using the format
271 C<alias/E<lt>alias-nameE<gt>>).
272  
273  
274  
275 =head2 EnvironmentTypeOverride => Str
276  
277 A container type for this build that overrides the one specified in the
278 build project.
279  
280 Valid values are: C<"WINDOWS_CONTAINER">, C<"LINUX_CONTAINER">, C<"LINUX_GPU_CONTAINER">, C<"ARM_CONTAINER">, C<"WINDOWS_SERVER_2019_CONTAINER">
281  
282 =head2 EnvironmentVariablesOverride => ArrayRef[L<Paws::CodeBuild::EnvironmentVariable>]
283  
284 A set of environment variables that overrides, for this build only, the
285 latest ones already defined in the build project.
286  
287  
288  
289 =head2 GitCloneDepthOverride => Int
290  
291 The user-defined depth of history, with a minimum value of 0, that
292 overrides, for this build only, any previous depth of history defined
293 in the build project.
294  
295  
296  
297 =head2 GitSubmodulesConfigOverride => L<Paws::CodeBuild::GitSubmodulesConfig>
298  
299 Information about the Git submodules configuration for this build of an
300 CodeBuild build project.
301  
302  
303  
304 =head2 IdempotencyToken => Str
305  
306 A unique, case sensitive identifier you provide to ensure the
307 idempotency of the StartBuild request. The token is included in the
308 StartBuild request and is valid for 5 minutes. If you repeat the
309 StartBuild request with the same token, but change a parameter,
310 CodeBuild returns a parameter mismatch error.
311  
312  
313  
314 =head2 ImageOverride => Str
315  
316 The name of an image for this build that overrides the one specified in
317 the build project.
318  
319  
320  
321 =head2 ImagePullCredentialsTypeOverride => Str
322  
323 The type of credentials CodeBuild uses to pull images in your build.
324 There are two valid values:
325  
326 =over
327  
328 =item CODEBUILD
329  
330 Specifies that CodeBuild uses its own credentials. This requires that
331 you modify your ECR repository policy to trust CodeBuild's service
332 principal.
333  
334 =item SERVICE_ROLE
335  
336 Specifies that CodeBuild uses your build project's service role.
337  
338 =back
339  
340 When using a cross-account or private registry image, you must use
341 C<SERVICE_ROLE> credentials. When using an CodeBuild curated image, you
342 must use C<CODEBUILD> credentials.
343  
344 Valid values are: C<"CODEBUILD">, C<"SERVICE_ROLE">
345  
346 =head2 InsecureSslOverride => Bool
347  
348 Enable this flag to override the insecure SSL setting that is specified
349 in the build project. The insecure SSL setting determines whether to
350 ignore SSL warnings while connecting to the project source code. This
351 override applies only if the build's source is GitHub Enterprise.
352  
353  
354  
355 =head2 LogsConfigOverride => L<Paws::CodeBuild::LogsConfig>
356  
357 Log settings for this build that override the log settings defined in
358 the build project.
359  
360  
361  
362 =head2 PrivilegedModeOverride => Bool
363  
364 Enable this flag to override privileged mode in the build project.
365  
366  
367  
368 =head2 B<REQUIRED> ProjectName => Str
369  
370 The name of the CodeBuild build project to start running a build.
371  
372  
373  
374 =head2 QueuedTimeoutInMinutesOverride => Int
375  
376 The number of minutes a build is allowed to be queued before it times
377 out.
378  
379  
380  
381 =head2 RegistryCredentialOverride => L<Paws::CodeBuild::RegistryCredential>
382  
383 The credentials for access to a private registry.
384  
385  
386  
387 =head2 ReportBuildStatusOverride => Bool
388  
389 Set to true to report to your source provider the status of a build's
390 start and completion. If you use this option with a source provider
391 other than GitHub, GitHub Enterprise, or Bitbucket, an
392 C<invalidInputException> is thrown.
393  
394 To be able to report the build status to the source provider, the user
395 associated with the source provider must have write access to the repo.
396 If the user does not have write access, the build status cannot be
397 updated. For more information, see Source provider access
398 (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html)
399 in the I<CodeBuild User Guide>.
400  
401 The status of a build triggered by a webhook is always reported to your
402 source provider.
403  
404  
405  
406 =head2 SecondaryArtifactsOverride => ArrayRef[L<Paws::CodeBuild::ProjectArtifacts>]
407  
408 An array of C<ProjectArtifacts> objects.
409  
410  
411  
412 =head2 SecondarySourcesOverride => ArrayRef[L<Paws::CodeBuild::ProjectSource>]
413  
414 An array of C<ProjectSource> objects.
415  
416  
417  
418 =head2 SecondarySourcesVersionOverride => ArrayRef[L<Paws::CodeBuild::ProjectSourceVersion>]
419  
420 An array of C<ProjectSourceVersion> objects that specify one or more
421 versions of the project's secondary sources to be used for this build
422 only.
423  
424  
425  
426 =head2 ServiceRoleOverride => Str
427  
428 The name of a service role for this build that overrides the one
429 specified in the build project.
430  
431  
432  
433 =head2 SourceAuthOverride => L<Paws::CodeBuild::SourceAuth>
434  
435 An authorization type for this build that overrides the one defined in
436 the build project. This override applies only if the build project's
437 source is BitBucket or GitHub.
438  
439  
440  
441 =head2 SourceLocationOverride => Str
442  
443 A location that overrides, for this build, the source location for the
444 one defined in the build project.
445  
446  
447  
448 =head2 SourceTypeOverride => Str
449  
450 A source input type, for this build, that overrides the source input
451 defined in the build project.
452  
453 Valid values are: C<"CODECOMMIT">, C<"CODEPIPELINE">, C<"GITHUB">, C<"S3">, C<"BITBUCKET">, C<"GITHUB_ENTERPRISE">, C<"NO_SOURCE">
454  
455 =head2 SourceVersion => Str
456  
457 The version of the build input to be built, for this build only. If not
458 specified, the latest version is used. If specified, the contents
459 depends on the source provider:
460  
461 =over
462  
463 =item CodeCommit
464  
465 The commit ID, branch, or Git tag to use.
466  
467 =item GitHub
468  
469 The commit ID, pull request ID, branch name, or tag name that
470 corresponds to the version of the source code you want to build. If a
471 pull request ID is specified, it must use the format
472 C<pr/pull-request-ID> (for example C<pr/25>). If a branch name is
473 specified, the branch's HEAD commit ID is used. If not specified, the
474 default branch's HEAD commit ID is used.
475  
476 =item Bitbucket
477  
478 The commit ID, branch name, or tag name that corresponds to the version
479 of the source code you want to build. If a branch name is specified,
480 the branch's HEAD commit ID is used. If not specified, the default
481 branch's HEAD commit ID is used.
482  
483 =item Amazon S3
484  
485 The version ID of the object that represents the build input ZIP file
486 to use.
487  
488 =back
489  
490 If C<sourceVersion> is specified at the project level, then this
491 C<sourceVersion> (at the build level) takes precedence.
492  
493 For more information, see Source Version Sample with CodeBuild
494 (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
495 in the I<CodeBuild User Guide>.
496  
497  
498  
499 =head2 TimeoutInMinutesOverride => Int
500  
501 The number of build timeout minutes, from 5 to 480 (8 hours), that
502 overrides, for this build only, the latest setting already defined in
503 the build project.
504  
505  
506  
507  
508 =head1 SEE ALSO
509  
510 This class forms part of L<Paws>, documenting arguments for method StartBuild in L<Paws::CodeBuild>
511  
512 =head1 BUGS and CONTRIBUTIONS
513  
514 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
515  
516 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
517  
518 =cut
519