Interface ReportGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ReportGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
date="2024-04-24T21:00:27.065Z")
@Stability(Stable)
public interface ReportGroupProps
extends software.amazon.jsii.JsiiSerializable
Construction properties for
ReportGroup
.
Example:
Source source; // create a new ReportGroup ReportGroup reportGroup = ReportGroup.Builder.create(this, "ReportGroup") .type(ReportGroupType.CODE_COVERAGE) .build(); Project project = Project.Builder.create(this, "Project") .source(source) .buildSpec(BuildSpec.fromObject(Map.of( // ... "reports", Map.of( reportGroup.getReportGroupArn(), Map.of( "files", "**/*", "base-directory", "build/coverage-report.xml", "file-format", "JACOCOXML"))))) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forReportGroupProps
static final class
An implementation forReportGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReportGroupProps.Builder
builder()
default IBucket
An optional S3 bucket to export the reports to.default RemovalPolicy
What to do when this resource is deleted from a stack.default String
The physical name of the report group.default ReportGroupType
getType()
The type of report group.default Boolean
Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExportBucket
An optional S3 bucket to export the reports to.Default: - the reports will not be exported
-
getRemovalPolicy
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
-
getReportGroupName
The physical name of the report group.Default: - CloudFormation-generated name
-
getType
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
-
getZipExport
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)
-
builder
- Returns:
- a
ReportGroupProps.Builder
ofReportGroupProps
-