Package software.amazon.awscdk.services.codebuild

Interface CfnReportGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReportGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.199Z")
@Stability(Stable)
public interface CfnReportGroupProps
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExportConfig

@Stability(Stable)
@NotNull
Object getExportConfig()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-exportconfig

getType

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-type

getDeleteReports

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-deletereports

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the ReportGroup .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-name

getTags

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-tags

builder

@Stability(Stable)
static CfnReportGroupProps.Builder builder()

Returns:

a CfnReportGroupProps.Builder of CfnReportGroupProps