| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::BuildBatch; | ||
| 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 BuildBatchConfig => (is => 'ro', isa => 'Paws::CodeBuild::ProjectBuildBatchConfig', request_name => 'buildBatchConfig', traits => ['NameInRequest']); | ||
| 7 | has BuildBatchNumber => (is => 'ro', isa => 'Int', request_name => 'buildBatchNumber', traits => ['NameInRequest']); | ||
| 8 | has BuildBatchStatus => (is => 'ro', isa => 'Str', request_name => 'buildBatchStatus', traits => ['NameInRequest']); | ||
| 9 | has BuildGroups => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::BuildGroup]', request_name => 'buildGroups', traits => ['NameInRequest']); | ||
| 10 | has BuildTimeoutInMinutes => (is => 'ro', isa => 'Int', request_name => 'buildTimeoutInMinutes', traits => ['NameInRequest']); | ||
| 11 | has Cache => (is => 'ro', isa => 'Paws::CodeBuild::ProjectCache', request_name => 'cache', traits => ['NameInRequest']); | ||
| 12 | has Complete => (is => 'ro', isa => 'Bool', request_name => 'complete', traits => ['NameInRequest']); | ||
| 13 | has CurrentPhase => (is => 'ro', isa => 'Str', request_name => 'currentPhase', traits => ['NameInRequest']); | ||
| 14 | has DebugSessionEnabled => (is => 'ro', isa => 'Bool', request_name => 'debugSessionEnabled', traits => ['NameInRequest']); | ||
| 15 | has EncryptionKey => (is => 'ro', isa => 'Str', request_name => 'encryptionKey', traits => ['NameInRequest']); | ||
| 16 | has EndTime => (is => 'ro', isa => 'Str', request_name => 'endTime', traits => ['NameInRequest']); | ||
| 17 | has Environment => (is => 'ro', isa => 'Paws::CodeBuild::ProjectEnvironment', request_name => 'environment', traits => ['NameInRequest']); | ||
| 18 | has FileSystemLocations => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectFileSystemLocation]', request_name => 'fileSystemLocations', traits => ['NameInRequest']); | ||
| 19 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 20 | has Initiator => (is => 'ro', isa => 'Str', request_name => 'initiator', traits => ['NameInRequest']); | ||
| 21 | has LogConfig => (is => 'ro', isa => 'Paws::CodeBuild::LogsConfig', request_name => 'logConfig', traits => ['NameInRequest']); | ||
| 22 | has Phases => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::BuildBatchPhase]', 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 ResolvedSourceVersion => (is => 'ro', isa => 'Str', request_name => 'resolvedSourceVersion', traits => ['NameInRequest']); | ||
| 26 | has SecondaryArtifacts => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::BuildArtifacts]', request_name => 'secondaryArtifacts', traits => ['NameInRequest']); | ||
| 27 | has SecondarySources => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSource]', request_name => 'secondarySources', traits => ['NameInRequest']); | ||
| 28 | has SecondarySourceVersions => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSourceVersion]', request_name => 'secondarySourceVersions', traits => ['NameInRequest']); | ||
| 29 | has ServiceRole => (is => 'ro', isa => 'Str', request_name => 'serviceRole', traits => ['NameInRequest']); | ||
| 30 | has Source => (is => 'ro', isa => 'Paws::CodeBuild::ProjectSource', request_name => 'source', traits => ['NameInRequest']); | ||
| 31 | has SourceVersion => (is => 'ro', isa => 'Str', request_name => 'sourceVersion', traits => ['NameInRequest']); | ||
| 32 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 33 | has VpcConfig => (is => 'ro', isa => 'Paws::CodeBuild::VpcConfig', request_name => 'vpcConfig', traits => ['NameInRequest']); | ||
| 34 | |||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::CodeBuild::BuildBatch | ||
| 42 | |||
| 43 | =head1 USAGE | ||
| 44 | |||
| 45 | This class represents one of two things: | ||
| 46 | |||
| 47 | =head3 Arguments in a call to a service | ||
| 48 | |||
| 49 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 50 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 51 | |||
| 52 | As an example, if Att1 is expected to be a Paws::CodeBuild::BuildBatch object: | ||
| 53 | |||
| 54 | $service_obj->Method(Att1 => { Arn => $value, ..., VpcConfig => $value }); | ||
| 55 | |||
| 56 | =head3 Results returned from an API call | ||
| 57 | |||
| 58 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::BuildBatch object: | ||
| 59 | |||
| 60 | $result = $service_obj->Method(...); | ||
| 61 | $result->Att1->Arn | ||
| 62 | |||
| 63 | =head1 DESCRIPTION | ||
| 64 | |||
| 65 | Contains information about a batch build. | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Arn => Str | ||
| 71 | |||
| 72 | The ARN of the batch build. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Artifacts => L<Paws::CodeBuild::BuildArtifacts> | ||
| 76 | |||
| 77 | A C<BuildArtifacts> object the defines the build artifacts for this | ||
| 78 | batch build. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 BuildBatchConfig => L<Paws::CodeBuild::ProjectBuildBatchConfig> | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 BuildBatchNumber => Int | ||
| 87 | |||
| 88 | The number of the batch build. For each project, the | ||
| 89 | C<buildBatchNumber> of its first batch build is C<1>. The | ||
| 90 | C<buildBatchNumber> of each subsequent batch build is incremented by | ||
| 91 | C<1>. If a batch build is deleted, the C<buildBatchNumber> of other | ||
| 92 | batch builds does not change. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 BuildBatchStatus => Str | ||
| 96 | |||
| 97 | The status of the batch build. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 BuildGroups => ArrayRef[L<Paws::CodeBuild::BuildGroup>] | ||
| 101 | |||
| 102 | An array of C<BuildGroup> objects that define the build groups for the | ||
| 103 | batch build. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 BuildTimeoutInMinutes => Int | ||
| 107 | |||
| 108 | Specifies the maximum amount of time, in minutes, that the build in a | ||
| 109 | batch must be completed in. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Cache => L<Paws::CodeBuild::ProjectCache> | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 Complete => Bool | ||
| 118 | |||
| 119 | Indicates if the batch build is complete. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 CurrentPhase => Str | ||
| 123 | |||
| 124 | The current phase of the batch build. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 DebugSessionEnabled => Bool | ||
| 128 | |||
| 129 | Specifies if session debugging is enabled for this batch build. For | ||
| 130 | more information, see Viewing a running build in Session Manager | ||
| 131 | (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). | ||
| 132 | Batch session debugging is not supported for matrix batch builds. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 EncryptionKey => Str | ||
| 136 | |||
| 137 | The Key Management Service customer master key (CMK) to be used for | ||
| 138 | encrypting the batch build output artifacts. | ||
| 139 | |||
| 140 | You can use a cross-account KMS key to encrypt the build output | ||
| 141 | artifacts if your service role has permission to that key. | ||
| 142 | |||
| 143 | You can specify either the Amazon Resource Name (ARN) of the CMK or, if | ||
| 144 | available, the CMK's alias (using the format | ||
| 145 | C<alias/E<lt>alias-nameE<gt>>). | ||
| 146 | |||
| 147 | |||
| 148 | =head2 EndTime => Str | ||
| 149 | |||
| 150 | The date and time that the batch build ended. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 Environment => L<Paws::CodeBuild::ProjectEnvironment> | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 FileSystemLocations => ArrayRef[L<Paws::CodeBuild::ProjectFileSystemLocation>] | ||
| 159 | |||
| 160 | An array of C<ProjectFileSystemLocation> objects for the batch build | ||
| 161 | project. A C<ProjectFileSystemLocation> object specifies the | ||
| 162 | C<identifier>, C<location>, C<mountOptions>, C<mountPoint>, and C<type> | ||
| 163 | of a file system created using Amazon Elastic File System. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 Id => Str | ||
| 167 | |||
| 168 | The identifier of the batch build. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 Initiator => Str | ||
| 172 | |||
| 173 | The entity that started the batch build. Valid values include: | ||
| 174 | |||
| 175 | =over | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | If CodePipeline started the build, the pipeline's name (for example, | ||
| 180 | C<codepipeline/my-demo-pipeline>). | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | If an Identity and Access Management user started the build, the user's | ||
| 185 | name. | ||
| 186 | |||
| 187 | =item * | ||
| 188 | |||
| 189 | If the Jenkins plugin for CodeBuild started the build, the string | ||
| 190 | C<CodeBuild-Jenkins-Plugin>. | ||
| 191 | |||
| 192 | =back | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 LogConfig => L<Paws::CodeBuild::LogsConfig> | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head2 Phases => ArrayRef[L<Paws::CodeBuild::BuildBatchPhase>] | ||
| 202 | |||
| 203 | An array of C<BuildBatchPhase> objects the specify the phases of the | ||
| 204 | batch build. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 ProjectName => Str | ||
| 208 | |||
| 209 | The name of the batch build project. | ||
| 210 | |||
| 211 | |||
| 212 | =head2 QueuedTimeoutInMinutes => Int | ||
| 213 | |||
| 214 | Specifies the amount of time, in minutes, that the batch build is | ||
| 215 | allowed to be queued before it times out. | ||
| 216 | |||
| 217 | |||
| 218 | =head2 ResolvedSourceVersion => Str | ||
| 219 | |||
| 220 | The identifier of the resolved version of this batch build's source | ||
| 221 | code. | ||
| 222 | |||
| 223 | =over | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit | ||
| 228 | ID. | ||
| 229 | |||
| 230 | =item * | ||
| 231 | |||
| 232 | For CodePipeline, the source revision provided by CodePipeline. | ||
| 233 | |||
| 234 | =item * | ||
| 235 | |||
| 236 | For Amazon S3, this does not apply. | ||
| 237 | |||
| 238 | =back | ||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head2 SecondaryArtifacts => ArrayRef[L<Paws::CodeBuild::BuildArtifacts>] | ||
| 243 | |||
| 244 | An array of C<BuildArtifacts> objects the define the build artifacts | ||
| 245 | for this batch build. | ||
| 246 | |||
| 247 | |||
| 248 | =head2 SecondarySources => ArrayRef[L<Paws::CodeBuild::ProjectSource>] | ||
| 249 | |||
| 250 | An array of C<ProjectSource> objects that define the sources for the | ||
| 251 | batch build. | ||
| 252 | |||
| 253 | |||
| 254 | =head2 SecondarySourceVersions => ArrayRef[L<Paws::CodeBuild::ProjectSourceVersion>] | ||
| 255 | |||
| 256 | An array of C<ProjectSourceVersion> objects. Each | ||
| 257 | C<ProjectSourceVersion> must be one of: | ||
| 258 | |||
| 259 | =over | ||
| 260 | |||
| 261 | =item * | ||
| 262 | |||
| 263 | For CodeCommit: the commit ID, branch, or Git tag to use. | ||
| 264 | |||
| 265 | =item * | ||
| 266 | |||
| 267 | For GitHub: the commit ID, pull request ID, branch name, or tag name | ||
| 268 | that corresponds to the version of the source code you want to build. | ||
| 269 | If a pull request ID is specified, it must use the format | ||
| 270 | C<pr/pull-request-ID> (for example, C<pr/25>). If a branch name is | ||
| 271 | specified, the branch's HEAD commit ID is used. If not specified, the | ||
| 272 | default branch's HEAD commit ID is used. | ||
| 273 | |||
| 274 | =item * | ||
| 275 | |||
| 276 | For Bitbucket: the commit ID, branch name, or tag name that corresponds | ||
| 277 | to the version of the source code you want to build. If a branch name | ||
| 278 | is specified, the branch's HEAD commit ID is used. If not specified, | ||
| 279 | the default branch's HEAD commit ID is used. | ||
| 280 | |||
| 281 | =item * | ||
| 282 | |||
| 283 | For Amazon S3: the version ID of the object that represents the build | ||
| 284 | input ZIP file to use. | ||
| 285 | |||
| 286 | =back | ||
| 287 | |||
| 288 | |||
| 289 | |||
| 290 | =head2 ServiceRole => Str | ||
| 291 | |||
| 292 | The name of a service role used for builds in the batch. | ||
| 293 | |||
| 294 | |||
| 295 | =head2 Source => L<Paws::CodeBuild::ProjectSource> | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | |||
| 300 | =head2 SourceVersion => Str | ||
| 301 | |||
| 302 | The identifier of the version of the source code to be built. | ||
| 303 | |||
| 304 | |||
| 305 | =head2 StartTime => Str | ||
| 306 | |||
| 307 | The date and time that the batch build started. | ||
| 308 | |||
| 309 | |||
| 310 | =head2 VpcConfig => L<Paws::CodeBuild::VpcConfig> | ||
| 311 | |||
| 312 | |||
| 313 | |||
| 314 | |||
| 315 | |||
| 316 | =head1 SEE ALSO | ||
| 317 | |||
| 318 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 319 | |||
| 320 | =head1 BUGS and CONTRIBUTIONS | ||
| 321 | |||
| 322 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 323 | |||
| 324 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 325 | |||
| 326 | =cut | ||
| 327 |