« blib/lib/Paws/CodeBuild/BatchRestrictions.pm
↑ Summary
blib/lib/Paws/CodeBuild/BuildArtifacts.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::Build; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has Artifacts => (is => 'ro', isa => 'Paws::CodeBuild::BuildArtifacts', request_name => 'artifacts', traits => ['NameInRequest']); | ||
| 6 | has BuildBatchArn => (is => 'ro', isa => 'Str', request_name => 'buildBatchArn', traits => ['NameInRequest']); | ||
| 7 | has BuildComplete => (is => 'ro', isa => 'Bool', request_name => 'buildComplete', traits => ['NameInRequest']); | ||
| 8 | has BuildNumber => (is => 'ro', isa => 'Int', request_name => 'buildNumber', traits => ['NameInRequest']); | ||
| 9 | has BuildStatus => (is => 'ro', isa => 'Str', request_name => 'buildStatus', traits => ['NameInRequest']); | ||
| 10 | has Cache => (is => 'ro', isa => 'Paws::CodeBuild::ProjectCache', request_name => 'cache', traits => ['NameInRequest']); | ||
| 11 | has CurrentPhase => (is => 'ro', isa => 'Str', request_name => 'currentPhase', traits => ['NameInRequest']); | ||
| 12 | has DebugSession => (is => 'ro', isa => 'Paws::CodeBuild::DebugSession', request_name => 'debugSession', traits => ['NameInRequest']); | ||
| 13 | has EncryptionKey => (is => 'ro', isa => 'Str', request_name => 'encryptionKey', traits => ['NameInRequest']); | ||
| 14 | has EndTime => (is => 'ro', isa => 'Str', request_name => 'endTime', traits => ['NameInRequest']); | ||
| 15 | has Environment => (is => 'ro', isa => 'Paws::CodeBuild::ProjectEnvironment', request_name => 'environment', traits => ['NameInRequest']); | ||
| 16 | has ExportedEnvironmentVariables => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ExportedEnvironmentVariable]', request_name => 'exportedEnvironmentVariables', traits => ['NameInRequest']); | ||
| 17 | has FileSystemLocations => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectFileSystemLocation]', request_name => 'fileSystemLocations', traits => ['NameInRequest']); | ||
| 18 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 19 | has Initiator => (is => 'ro', isa => 'Str', request_name => 'initiator', traits => ['NameInRequest']); | ||
| 20 | has Logs => (is => 'ro', isa => 'Paws::CodeBuild::LogsLocation', request_name => 'logs', traits => ['NameInRequest']); | ||
| 21 | has NetworkInterface => (is => 'ro', isa => 'Paws::CodeBuild::NetworkInterface', request_name => 'networkInterface', traits => ['NameInRequest']); | ||
| 22 | has Phases => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::BuildPhase]', request_name => 'phases', traits => ['NameInRequest']); | ||
| 23 | has ProjectName => (is => 'ro', isa => 'Str', request_name => 'projectName', traits => ['NameInRequest']); | ||
| 24 | has QueuedTimeoutInMinutes => (is => 'ro', isa => 'Int', request_name => 'queuedTimeoutInMinutes', traits => ['NameInRequest']); | ||
| 25 | has ReportArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'reportArns', traits => ['NameInRequest']); | ||
| 26 | has ResolvedSourceVersion => (is => 'ro', isa => 'Str', request_name => 'resolvedSourceVersion', traits => ['NameInRequest']); | ||
| 27 | has SecondaryArtifacts => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::BuildArtifacts]', request_name => 'secondaryArtifacts', traits => ['NameInRequest']); | ||
| 28 | has SecondarySources => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSource]', request_name => 'secondarySources', traits => ['NameInRequest']); | ||
| 29 | has SecondarySourceVersions => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSourceVersion]', request_name => 'secondarySourceVersions', traits => ['NameInRequest']); | ||
| 30 | has ServiceRole => (is => 'ro', isa => 'Str', request_name => 'serviceRole', traits => ['NameInRequest']); | ||
| 31 | has Source => (is => 'ro', isa => 'Paws::CodeBuild::ProjectSource', request_name => 'source', traits => ['NameInRequest']); | ||
| 32 | has SourceVersion => (is => 'ro', isa => 'Str', request_name => 'sourceVersion', traits => ['NameInRequest']); | ||
| 33 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 34 | has TimeoutInMinutes => (is => 'ro', isa => 'Int', request_name => 'timeoutInMinutes', traits => ['NameInRequest']); | ||
| 35 | has VpcConfig => (is => 'ro', isa => 'Paws::CodeBuild::VpcConfig', request_name => 'vpcConfig', traits => ['NameInRequest']); | ||
| 36 | |||
| 37 | 1; | ||
| 38 | |||
| 39 | ### main pod documentation begin ### | ||
| 40 | |||
| 41 | =head1 NAME | ||
| 42 | |||
| 43 | Paws::CodeBuild::Build | ||
| 44 | |||
| 45 | =head1 USAGE | ||
| 46 | |||
| 47 | This class represents one of two things: | ||
| 48 | |||
| 49 | =head3 Arguments in a call to a service | ||
| 50 | |||
| 51 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 52 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 53 | |||
| 54 | As an example, if Att1 is expected to be a Paws::CodeBuild::Build object: | ||
| 55 | |||
| 56 | $service_obj->Method(Att1 => { Arn => $value, ..., VpcConfig => $value }); | ||
| 57 | |||
| 58 | =head3 Results returned from an API call | ||
| 59 | |||
| 60 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::Build object: | ||
| 61 | |||
| 62 | $result = $service_obj->Method(...); | ||
| 63 | $result->Att1->Arn | ||
| 64 | |||
| 65 | =head1 DESCRIPTION | ||
| 66 | |||
| 67 | Information about a build. | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Arn => Str | ||
| 73 | |||
| 74 | The Amazon Resource Name (ARN) of the build. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Artifacts => L<Paws::CodeBuild::BuildArtifacts> | ||
| 78 | |||
| 79 | Information about the output artifacts for the build. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 BuildBatchArn => Str | ||
| 83 | |||
| 84 | The ARN of the batch build that this build is a member of, if | ||
| 85 | applicable. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 BuildComplete => Bool | ||
| 89 | |||
| 90 | Whether the build is complete. True if complete; otherwise, false. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 BuildNumber => Int | ||
| 94 | |||
| 95 | The number of the build. For each project, the C<buildNumber> of its | ||
| 96 | first build is C<1>. The C<buildNumber> of each subsequent build is | ||
| 97 | incremented by C<1>. If a build is deleted, the C<buildNumber> of other | ||
| 98 | builds does not change. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 BuildStatus => Str | ||
| 102 | |||
| 103 | The current status of the build. Valid values include: | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<FAILED>: The build failed. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<FAULT>: The build faulted. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<IN_PROGRESS>: The build is still in progress. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<STOPPED>: The build stopped. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<SUCCEEDED>: The build succeeded. | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | C<TIMED_OUT>: The build timed out. | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 Cache => L<Paws::CodeBuild::ProjectCache> | ||
| 136 | |||
| 137 | Information about the cache for the build. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 CurrentPhase => Str | ||
| 141 | |||
| 142 | The current build phase. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 DebugSession => L<Paws::CodeBuild::DebugSession> | ||
| 146 | |||
| 147 | Contains information about the debug session for this build. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 EncryptionKey => Str | ||
| 151 | |||
| 152 | The Key Management Service customer master key (CMK) to be used for | ||
| 153 | encrypting the build output artifacts. | ||
| 154 | |||
| 155 | You can use a cross-account KMS key to encrypt the build output | ||
| 156 | artifacts if your service role has permission to that key. | ||
| 157 | |||
| 158 | You can specify either the Amazon Resource Name (ARN) of the CMK or, if | ||
| 159 | available, the CMK's alias (using the format | ||
| 160 | C<alias/E<lt>alias-nameE<gt>>). | ||
| 161 | |||
| 162 | |||
| 163 | =head2 EndTime => Str | ||
| 164 | |||
| 165 | When the build process ended, expressed in Unix time format. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 Environment => L<Paws::CodeBuild::ProjectEnvironment> | ||
| 169 | |||
| 170 | Information about the build environment for this build. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 ExportedEnvironmentVariables => ArrayRef[L<Paws::CodeBuild::ExportedEnvironmentVariable>] | ||
| 174 | |||
| 175 | A list of exported environment variables for this build. | ||
| 176 | |||
| 177 | Exported environment variables are used in conjunction with | ||
| 178 | CodePipeline to export environment variables from the current build | ||
| 179 | stage to subsequent stages in the pipeline. For more information, see | ||
| 180 | Working with variables | ||
| 181 | (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) | ||
| 182 | in the I<CodePipeline User Guide>. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 FileSystemLocations => ArrayRef[L<Paws::CodeBuild::ProjectFileSystemLocation>] | ||
| 186 | |||
| 187 | An array of C<ProjectFileSystemLocation> objects for a CodeBuild build | ||
| 188 | project. A C<ProjectFileSystemLocation> object specifies the | ||
| 189 | C<identifier>, C<location>, C<mountOptions>, C<mountPoint>, and C<type> | ||
| 190 | of a file system created using Amazon Elastic File System. | ||
| 191 | |||
| 192 | |||
| 193 | =head2 Id => Str | ||
| 194 | |||
| 195 | The unique ID for the build. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 Initiator => Str | ||
| 199 | |||
| 200 | The entity that started the build. Valid values include: | ||
| 201 | |||
| 202 | =over | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | If CodePipeline started the build, the pipeline's name (for example, | ||
| 207 | C<codepipeline/my-demo-pipeline>). | ||
| 208 | |||
| 209 | =item * | ||
| 210 | |||
| 211 | If an Identity and Access Management user started the build, the user's | ||
| 212 | name (for example, C<MyUserName>). | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | If the Jenkins plugin for CodeBuild started the build, the string | ||
| 217 | C<CodeBuild-Jenkins-Plugin>. | ||
| 218 | |||
| 219 | =back | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head2 Logs => L<Paws::CodeBuild::LogsLocation> | ||
| 224 | |||
| 225 | Information about the build's logs in CloudWatch Logs. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 NetworkInterface => L<Paws::CodeBuild::NetworkInterface> | ||
| 229 | |||
| 230 | Describes a network interface. | ||
| 231 | |||
| 232 | |||
| 233 | =head2 Phases => ArrayRef[L<Paws::CodeBuild::BuildPhase>] | ||
| 234 | |||
| 235 | Information about all previous build phases that are complete and | ||
| 236 | information about any current build phase that is not yet complete. | ||
| 237 | |||
| 238 | |||
| 239 | =head2 ProjectName => Str | ||
| 240 | |||
| 241 | The name of the CodeBuild project. | ||
| 242 | |||
| 243 | |||
| 244 | =head2 QueuedTimeoutInMinutes => Int | ||
| 245 | |||
| 246 | The number of minutes a build is allowed to be queued before it times | ||
| 247 | out. | ||
| 248 | |||
| 249 | |||
| 250 | =head2 ReportArns => ArrayRef[Str|Undef] | ||
| 251 | |||
| 252 | An array of the ARNs associated with this build's reports. | ||
| 253 | |||
| 254 | |||
| 255 | =head2 ResolvedSourceVersion => Str | ||
| 256 | |||
| 257 | An identifier for the version of this build's source code. | ||
| 258 | |||
| 259 | =over | ||
| 260 | |||
| 261 | =item * | ||
| 262 | |||
| 263 | For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit | ||
| 264 | ID. | ||
| 265 | |||
| 266 | =item * | ||
| 267 | |||
| 268 | For CodePipeline, the source revision provided by CodePipeline. | ||
| 269 | |||
| 270 | =item * | ||
| 271 | |||
| 272 | For Amazon S3, this does not apply. | ||
| 273 | |||
| 274 | =back | ||
| 275 | |||
| 276 | |||
| 277 | |||
| 278 | =head2 SecondaryArtifacts => ArrayRef[L<Paws::CodeBuild::BuildArtifacts>] | ||
| 279 | |||
| 280 | An array of C<ProjectArtifacts> objects. | ||
| 281 | |||
| 282 | |||
| 283 | =head2 SecondarySources => ArrayRef[L<Paws::CodeBuild::ProjectSource>] | ||
| 284 | |||
| 285 | An array of C<ProjectSource> objects. | ||
| 286 | |||
| 287 | |||
| 288 | =head2 SecondarySourceVersions => ArrayRef[L<Paws::CodeBuild::ProjectSourceVersion>] | ||
| 289 | |||
| 290 | An array of C<ProjectSourceVersion> objects. Each | ||
| 291 | C<ProjectSourceVersion> must be one of: | ||
| 292 | |||
| 293 | =over | ||
| 294 | |||
| 295 | =item * | ||
| 296 | |||
| 297 | For CodeCommit: the commit ID, branch, or Git tag to use. | ||
| 298 | |||
| 299 | =item * | ||
| 300 | |||
| 301 | For GitHub: the commit ID, pull request ID, branch name, or tag name | ||
| 302 | that corresponds to the version of the source code you want to build. | ||
| 303 | If a pull request ID is specified, it must use the format | ||
| 304 | C<pr/pull-request-ID> (for example, C<pr/25>). If a branch name is | ||
| 305 | specified, the branch's HEAD commit ID is used. If not specified, the | ||
| 306 | default branch's HEAD commit ID is used. | ||
| 307 | |||
| 308 | =item * | ||
| 309 | |||
| 310 | For Bitbucket: the commit ID, branch name, or tag name that corresponds | ||
| 311 | to the version of the source code you want to build. If a branch name | ||
| 312 | is specified, the branch's HEAD commit ID is used. If not specified, | ||
| 313 | the default branch's HEAD commit ID is used. | ||
| 314 | |||
| 315 | =item * | ||
| 316 | |||
| 317 | For Amazon S3: the version ID of the object that represents the build | ||
| 318 | input ZIP file to use. | ||
| 319 | |||
| 320 | =back | ||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | =head2 ServiceRole => Str | ||
| 325 | |||
| 326 | The name of a service role used for this build. | ||
| 327 | |||
| 328 | |||
| 329 | =head2 Source => L<Paws::CodeBuild::ProjectSource> | ||
| 330 | |||
| 331 | Information about the source code to be built. | ||
| 332 | |||
| 333 | |||
| 334 | =head2 SourceVersion => Str | ||
| 335 | |||
| 336 | Any version identifier for the version of the source code to be built. | ||
| 337 | If C<sourceVersion> is specified at the project level, then this | ||
| 338 | C<sourceVersion> (at the build level) takes precedence. | ||
| 339 | |||
| 340 | For more information, see Source Version Sample with CodeBuild | ||
| 341 | (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) | ||
| 342 | in the I<CodeBuild User Guide>. | ||
| 343 | |||
| 344 | |||
| 345 | =head2 StartTime => Str | ||
| 346 | |||
| 347 | When the build process started, expressed in Unix time format. | ||
| 348 | |||
| 349 | |||
| 350 | =head2 TimeoutInMinutes => Int | ||
| 351 | |||
| 352 | How long, in minutes, for CodeBuild to wait before timing out this | ||
| 353 | build if it does not get marked as completed. | ||
| 354 | |||
| 355 | |||
| 356 | =head2 VpcConfig => L<Paws::CodeBuild::VpcConfig> | ||
| 357 | |||
| 358 | If your CodeBuild project accesses resources in an Amazon VPC, you | ||
| 359 | provide this parameter that identifies the VPC ID and the list of | ||
| 360 | security group IDs and subnet IDs. The security groups and subnets must | ||
| 361 | belong to the same VPC. You must provide at least one security group | ||
| 362 | and one subnet ID. | ||
| 363 | |||
| 364 | |||
| 365 | |||
| 366 | =head1 SEE ALSO | ||
| 367 | |||
| 368 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 369 | |||
| 370 | =head1 BUGS and CONTRIBUTIONS | ||
| 371 | |||
| 372 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 373 | |||
| 374 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 375 | |||
| 376 | =cut | ||
| 377 |