« blib/lib/Paws/CodeBuild/ProjectFileSystemLocation.pm
↑ Summary
blib/lib/Paws/CodeBuild/ProjectSourceVersion.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::ProjectSource; | ||
| 3 | use Moose; | ||
| 4 | has Auth => (is => 'ro', isa => 'Paws::CodeBuild::SourceAuth', request_name => 'auth', traits => ['NameInRequest']); | ||
| 5 | has Buildspec => (is => 'ro', isa => 'Str', request_name => 'buildspec', traits => ['NameInRequest']); | ||
| 6 | has BuildStatusConfig => (is => 'ro', isa => 'Paws::CodeBuild::BuildStatusConfig', request_name => 'buildStatusConfig', traits => ['NameInRequest']); | ||
| 7 | has GitCloneDepth => (is => 'ro', isa => 'Int', request_name => 'gitCloneDepth', traits => ['NameInRequest']); | ||
| 8 | has GitSubmodulesConfig => (is => 'ro', isa => 'Paws::CodeBuild::GitSubmodulesConfig', request_name => 'gitSubmodulesConfig', traits => ['NameInRequest']); | ||
| 9 | has InsecureSsl => (is => 'ro', isa => 'Bool', request_name => 'insecureSsl', traits => ['NameInRequest']); | ||
| 10 | has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']); | ||
| 11 | has ReportBuildStatus => (is => 'ro', isa => 'Bool', request_name => 'reportBuildStatus', traits => ['NameInRequest']); | ||
| 12 | has SourceIdentifier => (is => 'ro', isa => 'Str', request_name => 'sourceIdentifier', traits => ['NameInRequest']); | ||
| 13 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CodeBuild::ProjectSource | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectSource object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { Auth => $value, ..., Type => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectSource object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->Auth | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Information about the build input source code for the build project. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Auth => L<Paws::CodeBuild::SourceAuth> | ||
| 51 | |||
| 52 | Information about the authorization settings for CodeBuild to access | ||
| 53 | the source code to be built. | ||
| 54 | |||
| 55 | This information is for the CodeBuild console's use only. Your code | ||
| 56 | should not get or set this information directly. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Buildspec => Str | ||
| 60 | |||
| 61 | The buildspec file declaration to use for the builds in this build | ||
| 62 | project. | ||
| 63 | |||
| 64 | If this value is set, it can be either an inline buildspec definition, | ||
| 65 | the path to an alternate buildspec file relative to the value of the | ||
| 66 | built-in C<CODEBUILD_SRC_DIR> environment variable, or the path to an | ||
| 67 | S3 bucket. The bucket must be in the same Region as the build project. | ||
| 68 | Specify the buildspec file using its ARN (for example, | ||
| 69 | C<arn:aws:s3:::my-codebuild-sample2/buildspec.yml>). If this value is | ||
| 70 | not provided or is set to an empty string, the source code must contain | ||
| 71 | a buildspec file in its root directory. For more information, see | ||
| 72 | Buildspec File Name and Storage Location | ||
| 73 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). | ||
| 74 | |||
| 75 | |||
| 76 | =head2 BuildStatusConfig => L<Paws::CodeBuild::BuildStatusConfig> | ||
| 77 | |||
| 78 | Contains information that defines how the build project reports the | ||
| 79 | build status to the source provider. This option is only used when the | ||
| 80 | source provider is C<GITHUB>, C<GITHUB_ENTERPRISE>, or C<BITBUCKET>. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 GitCloneDepth => Int | ||
| 84 | |||
| 85 | Information about the Git clone depth for the build project. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 GitSubmodulesConfig => L<Paws::CodeBuild::GitSubmodulesConfig> | ||
| 89 | |||
| 90 | Information about the Git submodules configuration for the build | ||
| 91 | project. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 InsecureSsl => Bool | ||
| 95 | |||
| 96 | Enable this flag to ignore SSL warnings while connecting to the project | ||
| 97 | source code. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Location => Str | ||
| 101 | |||
| 102 | Information about the location of the source code to be built. Valid | ||
| 103 | values include: | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | For source code settings that are specified in the source action of a | ||
| 110 | pipeline in CodePipeline, C<location> should not be specified. If it is | ||
| 111 | specified, CodePipeline ignores it. This is because CodePipeline uses | ||
| 112 | the settings in a pipeline's source action instead of this value. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | For source code in an CodeCommit repository, the HTTPS clone URL to the | ||
| 117 | repository that contains the source code and the buildspec file (for | ||
| 118 | example, | ||
| 119 | C<https://git-codecommit.E<lt>region-IDE<gt>.amazonaws.com/v1/repos/E<lt>repo-nameE<gt>>). | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | For source code in an Amazon S3 input bucket, one of the following. | ||
| 124 | |||
| 125 | =over | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | The path to the ZIP file that contains the source code (for example, | ||
| 130 | C<E<lt>bucket-nameE<gt>/E<lt>pathE<gt>/E<lt>object-nameE<gt>.zip>). | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | The path to the folder that contains the source code (for example, | ||
| 135 | C<E<lt>bucket-nameE<gt>/E<lt>path-to-source-codeE<gt>/E<lt>folderE<gt>/>). | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | For source code in a GitHub repository, the HTTPS clone URL to the | ||
| 142 | repository that contains the source and the buildspec file. You must | ||
| 143 | connect your account to your GitHub account. Use the CodeBuild console | ||
| 144 | to start creating a build project. When you use the console to connect | ||
| 145 | (or reconnect) with GitHub, on the GitHub B<Authorize application> | ||
| 146 | page, for B<Organization access>, choose B<Request access> next to each | ||
| 147 | repository you want to allow CodeBuild to have access to, and then | ||
| 148 | choose B<Authorize application>. (After you have connected to your | ||
| 149 | GitHub account, you do not need to finish creating the build project. | ||
| 150 | You can leave the CodeBuild console.) To instruct CodeBuild to use this | ||
| 151 | connection, in the C<source> object, set the C<auth> object's C<type> | ||
| 152 | value to C<OAUTH>. | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | For source code in a Bitbucket repository, the HTTPS clone URL to the | ||
| 157 | repository that contains the source and the buildspec file. You must | ||
| 158 | connect your Amazon Web Services account to your Bitbucket account. Use | ||
| 159 | the CodeBuild console to start creating a build project. When you use | ||
| 160 | the console to connect (or reconnect) with Bitbucket, on the Bitbucket | ||
| 161 | B<Confirm access to your account> page, choose B<Grant access>. (After | ||
| 162 | you have connected to your Bitbucket account, you do not need to finish | ||
| 163 | creating the build project. You can leave the CodeBuild console.) To | ||
| 164 | instruct CodeBuild to use this connection, in the C<source> object, set | ||
| 165 | the C<auth> object's C<type> value to C<OAUTH>. | ||
| 166 | |||
| 167 | =back | ||
| 168 | |||
| 169 | If you specify C<CODEPIPELINE> for the C<Type> property, don't specify | ||
| 170 | this property. For all of the other types, you must specify | ||
| 171 | C<Location>. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 ReportBuildStatus => Bool | ||
| 175 | |||
| 176 | Set to true to report the status of a build's start and finish to your | ||
| 177 | source provider. This option is valid only when your source provider is | ||
| 178 | GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a | ||
| 179 | different source provider, an C<invalidInputException> is thrown. | ||
| 180 | |||
| 181 | To be able to report the build status to the source provider, the user | ||
| 182 | associated with the source provider must have write access to the repo. | ||
| 183 | If the user does not have write access, the build status cannot be | ||
| 184 | updated. For more information, see Source provider access | ||
| 185 | (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html) | ||
| 186 | in the I<CodeBuild User Guide>. | ||
| 187 | |||
| 188 | The status of a build triggered by a webhook is always reported to your | ||
| 189 | source provider. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 SourceIdentifier => Str | ||
| 193 | |||
| 194 | An identifier for this project source. The identifier can only contain | ||
| 195 | alphanumeric characters and underscores, and must be less than 128 | ||
| 196 | characters in length. | ||
| 197 | |||
| 198 | |||
| 199 | =head2 B<REQUIRED> Type => Str | ||
| 200 | |||
| 201 | The type of repository that contains the source code to be built. Valid | ||
| 202 | values include: | ||
| 203 | |||
| 204 | =over | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | C<BITBUCKET>: The source code is in a Bitbucket repository. | ||
| 209 | |||
| 210 | =item * | ||
| 211 | |||
| 212 | C<CODECOMMIT>: The source code is in an CodeCommit repository. | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | C<CODEPIPELINE>: The source code settings are specified in the source | ||
| 217 | action of a pipeline in CodePipeline. | ||
| 218 | |||
| 219 | =item * | ||
| 220 | |||
| 221 | C<GITHUB>: The source code is in a GitHub or GitHub Enterprise Cloud | ||
| 222 | repository. | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | C<GITHUB_ENTERPRISE>: The source code is in a GitHub Enterprise Server | ||
| 227 | repository. | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | C<NO_SOURCE>: The project does not have input source code. | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | C<S3>: The source code is in an Amazon S3 bucket. | ||
| 236 | |||
| 237 | =back | ||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head1 SEE ALSO | ||
| 243 | |||
| 244 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 245 | |||
| 246 | =head1 BUGS and CONTRIBUTIONS | ||
| 247 | |||
| 248 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 249 | |||
| 250 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 251 | |||
| 252 | =cut | ||
| 253 |