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