software.amazon.awscdk.services.codebuild

Interface CfnReportGroupProps

All Known Implementing Classes:

CfnReportGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:32.223Z")
public interface CfnReportGroupProps

Properties for defining a `CfnReportGroup`.

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.*;
 CfnReportGroupProps cfnReportGroupProps = CfnReportGroupProps.builder()
         .exportConfig(ReportExportConfigProperty.builder()
                 .exportConfigType("exportConfigType")
                 // the properties below are optional
                 .s3Destination(S3ReportExportConfigProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .bucketOwner("bucketOwner")
                         .encryptionDisabled(false)
                         .encryptionKey("encryptionKey")
                         .packaging("packaging")
                         .path("path")
                         .build())
                 .build())
         .type("type")
         // the properties below are optional
         .deleteReports(false)
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnReportGroupProps.Builder	builder()
default java.lang.Object	getDeleteReports() When deleting a report group, specifies if reports within the report group should be deleted.
java.lang.Object	getExportConfig() Information about the destination where the raw data of this `ReportGroup` is exported.
default java.lang.String	getName() The name of the `ReportGroup` .
default java.util.List<CfnTag>	getTags() A list of tag key and value pairs associated with this report group.
java.lang.String	getType() The type of the `ReportGroup` .

Method Detail

getExportConfig

java.lang.Object getExportConfig()

Information about the destination where the raw data of this `ReportGroup` is exported.

getType

java.lang.String getType()

The type of the `ReportGroup` . This can be one of the following values:.

• CODE_COVERAGE - The report group contains code coverage reports.
• TEST - The report group contains test reports.

getDeleteReports

default java.lang.Object getDeleteReports()

When deleting a report group, specifies if reports within the report group should be deleted.

• true - Deletes any reports that belong to the report group before deleting the report group.
• false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

getName

default java.lang.String getName()

The name of the `ReportGroup` .

getTags

default java.util.List<CfnTag> getTags()

A list of tag key and value pairs associated with this report group.

These tags are available for use by AWS services that support AWS CodeBuild report group tags.

builder

static CfnReportGroupProps.Builder builder()

Returns:

a CfnReportGroupProps.Builder of CfnReportGroupProps