File Coverage

blib/lib/Paws/CodeBuild/ProjectSource.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CodeBuild::ProjectSource;
2 1     1   410 use Moose;
  1         2  
  1         7  
3             has Auth => (is => 'ro', isa => 'Paws::CodeBuild::SourceAuth', request_name => 'auth', traits => ['NameInRequest']);
4             has Buildspec => (is => 'ro', isa => 'Str', request_name => 'buildspec', traits => ['NameInRequest']);
5             has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']);
6             has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CodeBuild::ProjectSource
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectSource object:
25              
26             $service_obj->Method(Att1 => { Auth => $value, ..., Type => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectSource object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Auth
34              
35             =head1 DESCRIPTION
36              
37             Information about the build input source code for the build project.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 Auth => L<Paws::CodeBuild::SourceAuth>
43              
44             Information about the authorization settings for AWS CodeBuild to
45             access the source code to be built.
46              
47             This information is for the AWS CodeBuild console's use only. Your code
48             should not get or set this information directly (unless the build
49             project's source C<type> value is C<BITBUCKET> or C<GITHUB>).
50              
51              
52             =head2 Buildspec => Str
53              
54             The build spec declaration to use for the builds in this build project.
55              
56             If this value is not specified, a build spec must be included along
57             with the source code to be built.
58              
59              
60             =head2 Location => Str
61              
62             Information about the location of the source code to be built. Valid
63             values include:
64              
65             =over
66              
67             =item *
68              
69             For source code settings that are specified in the source action of a
70             pipeline in AWS CodePipeline, C<location> should not be specified. If
71             it is specified, AWS CodePipeline will ignore it. This is because AWS
72             CodePipeline uses the settings in a pipeline's source action instead of
73             this value.
74              
75             =item *
76              
77             For source code in an AWS CodeCommit repository, the HTTPS clone URL to
78             the repository that contains the source code and the build spec (for
79             example,
80             C<https://git-codecommit.I<region-ID>.amazonaws.com/v1/repos/I<repo-name>
81             >).
82              
83             =item *
84              
85             For source code in an Amazon Simple Storage Service (Amazon S3) input
86             bucket, the path to the ZIP file that contains the source code (for
87             example, C< I<bucket-name>/I<path>/I<to>/I<object-name>.zip>)
88              
89             =item *
90              
91             For source code in a GitHub repository, the HTTPS clone URL to the
92             repository that contains the source and the build spec. Also, you must
93             connect your AWS account to your GitHub account. To do this, use the
94             AWS CodeBuild console to begin creating a build project. When you use
95             the console to connect (or reconnect) with GitHub, on the GitHub
96             B<Authorize application> page that displays, for B<Organization
97             access>, choose B<Request access> next to each repository you want to
98             allow AWS CodeBuild to have access to. Then choose B<Authorize
99             application>. (After you have connected to your GitHub account, you do
100             not need to finish creating the build project, and you may then leave
101             the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this
102             connection, in the C<source> object, set the C<auth> object's C<type>
103             value to C<OAUTH>.
104              
105             =item *
106              
107             For source code in a Bitbucket repository, the HTTPS clone URL to the
108             repository that contains the source and the build spec. Also, you must
109             connect your AWS account to your Bitbucket account. To do this, use the
110             AWS CodeBuild console to begin creating a build project. When you use
111             the console to connect (or reconnect) with Bitbucket, on the Bitbucket
112             B<Confirm access to your account> page that displays, choose B<Grant
113             access>. (After you have connected to your Bitbucket account, you do
114             not need to finish creating the build project, and you may then leave
115             the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this
116             connection, in the C<source> object, set the C<auth> object's C<type>
117             value to C<OAUTH>.
118              
119             =back
120              
121              
122              
123             =head2 B<REQUIRED> Type => Str
124              
125             The type of repository that contains the source code to be built. Valid
126             values include:
127              
128             =over
129              
130             =item *
131              
132             C<BITBUCKET>: The source code is in a Bitbucket repository.
133              
134             =item *
135              
136             C<CODECOMMIT>: The source code is in an AWS CodeCommit repository.
137              
138             =item *
139              
140             C<CODEPIPELINE>: The source code settings are specified in the source
141             action of a pipeline in AWS CodePipeline.
142              
143             =item *
144              
145             C<GITHUB>: The source code is in a GitHub repository.
146              
147             =item *
148              
149             C<S3>: The source code is in an Amazon Simple Storage Service (Amazon
150             S3) input bucket.
151              
152             =back
153              
154              
155              
156              
157             =head1 SEE ALSO
158              
159             This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild>
160              
161             =head1 BUGS and CONTRIBUTIONS
162              
163             The source code is located here: https://github.com/pplu/aws-sdk-perl
164              
165             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
166              
167             =cut
168