Package software.amazon.awscdk.services.codebuild

Interface CfnProject.ProjectBuildBatchConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProject.ProjectBuildBatchConfigProperty.Jsii$Proxy

Enclosing class:

CfnProject

@Stability(Stable)
public static interface CfnProject.ProjectBuildBatchConfigProperty
extends software.amazon.jsii.JsiiSerializable

Contains configuration information about a batch build project.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 ProjectBuildBatchConfigProperty projectBuildBatchConfigProperty = ProjectBuildBatchConfigProperty.builder()
         .batchReportMode("batchReportMode")
         .combineArtifacts(false)
         .restrictions(BatchRestrictionsProperty.builder()
                 .computeTypesAllowed(List.of("computeTypesAllowed"))
                 .maximumBuildsAllowed(123)
                 .build())
         .serviceRole("serviceRole")
         .timeoutInMins(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProject.ProjectBuildBatchConfigProperty.Builder	A builder for CfnProject.ProjectBuildBatchConfigProperty
static final class	CfnProject.ProjectBuildBatchConfigProperty.Jsii$Proxy	An implementation for CfnProject.ProjectBuildBatchConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnProject.ProjectBuildBatchConfigProperty.Builder	builder()
default String	getBatchReportMode()	Specifies how build status reports are sent to the source provider for the batch build.
default Object	getCombineArtifacts()	Specifies if the build artifacts for the batch build should be combined into a single artifact location.
default Object	getRestrictions()	A BatchRestrictions object that specifies the restrictions for the batch build.
default String	getServiceRole()	Specifies the service role ARN for the batch build project.
default Number	getTimeoutInMins()	Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchReportMode

@Stability(Stable)
@Nullable
default String getBatchReportMode()

Specifies how build status reports are sent to the source provider for the batch build.

This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.

• REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
• REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-batchreportmode

getCombineArtifacts

@Stability(Stable)
@Nullable
default Object getCombineArtifacts()

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts

getRestrictions

@Stability(Stable)
@Nullable
default Object getRestrictions()

A BatchRestrictions object that specifies the restrictions for the batch build.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-restrictions

getServiceRole

@Stability(Stable)
@Nullable
default String getServiceRole()

Specifies the service role ARN for the batch build project.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-servicerole

getTimeoutInMins

@Stability(Stable)
@Nullable
default Number getTimeoutInMins()

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins

builder

@Stability(Stable)
static CfnProject.ProjectBuildBatchConfigProperty.Builder builder()

Returns:

a CfnProject.ProjectBuildBatchConfigProperty.Builder of CfnProject.ProjectBuildBatchConfigProperty