AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ReportGroup

The ReportGroup resource class.

Import

import { ReportGroup } from 'aws-cdk-lib/aws-codebuild';

Or use the module namespace:

import * as codebuild from 'aws-cdk-lib/aws-codebuild';
// codebuild.ReportGroup

Properties

Configuration passed to the constructor as ReportGroupProps.

deleteReportsOptional
boolean

If true, deleting the report group force deletes the contents of the report group. If false, the report group must be empty before attempting to delete it.

Default: false

exportBucketOptional
IBucket

An optional S3 bucket to export the reports to.

Default: - the reports will not be exported

removalPolicyOptional
RemovalPolicy

What to do when this resource is deleted from a stack. As CodeBuild does not allow deleting a ResourceGroup that has reports inside of it, this is set to retain the resource by default.

Default: RemovalPolicy.RETAIN

reportGroupNameOptional
string

The physical name of the report group.

Default: - CloudFormation-generated name

typeOptional
ReportGroupType

The type of report group. This can be one of the following values:. - **TEST** - The report group contains test reports. - **CODE_COVERAGE** - The report group contains code coverage reports.

Default: TEST

zipExportOptional
boolean

Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export. Ignored if `exportBucket` has not been provided.

Default: - false (the files will not be ZIPped)

Get the AWS CodeBuild Cheat Sheet

Everything you need to know about AWS CodeBuild on one page. HD quality, print-friendly.

Download Free Infographic