Skip to content
v2.276.0

ProjectBuildBatchConfigProperty Struct ​

Contains configuration information about a batch build project.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const projectBuildBatchConfigProperty: codebuild.CfnProject.ProjectBuildBatchConfigProperty = {
  batchReportMode: 'batchReportMode',
  combineArtifacts: false,
  restrictions: {
    computeTypesAllowed: ['computeTypesAllowed'],
    fleetsAllowed: ['fleetsAllowed'],
    maximumBuildsAllowed: 123,
  },
  serviceRole: 'serviceRole',
  timeoutInMins: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild

project_build_batch_config_property = codebuild.CfnProject.ProjectBuildBatchConfigProperty(
    batch_report_mode="batchReportMode",
    combine_artifacts=False,
    restrictions=codebuild.CfnProject.BatchRestrictionsProperty(
        compute_types_allowed=["computeTypesAllowed"],
        fleets_allowed=["fleetsAllowed"],
        maximum_builds_allowed=123
    ),
    service_role="serviceRole",
    timeout_in_mins=123
)
java
// 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"))
                .fleetsAllowed(List.of("fleetsAllowed"))
                .maximumBuildsAllowed(123)
                .build())
        .serviceRole("serviceRole")
        .timeoutInMins(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;

var projectBuildBatchConfigProperty = new ProjectBuildBatchConfigProperty {
    BatchReportMode = "batchReportMode",
    CombineArtifacts = false,
    Restrictions = new BatchRestrictionsProperty {
        ComputeTypesAllowed = new [] { "computeTypesAllowed" },
        FleetsAllowed = new [] { "fleetsAllowed" },
        MaximumBuildsAllowed = 123
    },
    ServiceRole = "serviceRole",
    TimeoutInMins = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

projectBuildBatchConfigProperty := &ProjectBuildBatchConfigProperty{
	BatchReportMode: jsii.String("batchReportMode"),
	CombineArtifacts: jsii.Boolean(false),
	Restrictions: &BatchRestrictionsProperty{
		ComputeTypesAllowed: []*string{
			jsii.String("computeTypesAllowed"),
		},
		FleetsAllowed: []*string{
			jsii.String("fleetsAllowed"),
		},
		MaximumBuildsAllowed: jsii.Number(123),
	},
	ServiceRole: jsii.String("serviceRole"),
	TimeoutInMins: jsii.Number(123),
}

Properties ​

batchReportModeoptionalstringbatch_report_modeoptionalstrbatchReportModeoptionalStringBatchReportModeoptionalstringBatchReportModeoptional*string#
Specifies how build status reports are sent to the source provider for the batch build.
notes

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.
combineArtifactsoptionalboolean | IResolvablecombine_artifactsoptionaltyping.Union[bool, IResolvable]combineArtifactsoptionalBooleanCombineArtifactsoptionalboolCombineArtifactsoptionalinterface{}#
Specifies if the build artifacts for the batch build should be combined into a single artifact location.
restrictionsoptionalIResolvable | CfnProject.BatchRestrictionsPropertyrestrictionsoptionaltyping.Union[IResolvable, BatchRestrictionsProperty]restrictionsoptionalIResolvableRestrictionsoptionalIResolvableRestrictionsoptionalinterface{}#
A `BatchRestrictions` object that specifies the restrictions for the batch build.
serviceRoleoptionalstringservice_roleoptionalstrserviceRoleoptionalStringServiceRoleoptionalstringServiceRoleoptional*string#
Specifies the service role ARN for the batch build project.
timeoutInMinsoptionalnumbertimeout_in_minsoptionalint | floattimeoutInMinsoptionalNumberTimeoutInMinsoptionaldoubleTimeoutInMinsoptional*float64#
Specifies the maximum amount of time, in minutes, that the batch build must be completed in.