software.amazon.awscdk.services.codebuild

Interface ReportGroupProps

All Known Implementing Classes:

ReportGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.469Z")
public interface ReportGroupProps

Construction properties for ReportGroup.

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.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.core.*;
 Bucket bucket;
 ReportGroupProps reportGroupProps = ReportGroupProps.builder()
         .exportBucket(bucket)
         .removalPolicy(RemovalPolicy.DESTROY)
         .reportGroupName("reportGroupName")
         .zipExport(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ReportGroupProps.Builder	builder()
default IBucket	getExportBucket() An optional S3 bucket to export the reports to.
default RemovalPolicy	getRemovalPolicy() What to do when this resource is deleted from a stack.
default java.lang.String	getReportGroupName() The physical name of the report group.
default java.lang.Boolean	getZipExport() Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.

Method Detail

getExportBucket

default IBucket getExportBucket()

An optional S3 bucket to export the reports to.

Default: - the reports will not be exported

getRemovalPolicy

default RemovalPolicy 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

default java.lang.String getReportGroupName()

The physical name of the report group.

Default: - CloudFormation-generated name

getZipExport

default java.lang.Boolean 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 {@link exportBucket} has not been provided.

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

builder

static ReportGroupProps.Builder builder()

Returns:

a ReportGroupProps.Builder of ReportGroupProps