Package software.amazon.awscdk.services.codebuild

Class CfnReportGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.codebuild.CfnReportGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.758Z") @Stability(Stable) public class CfnReportGroup extends CfnResource implements IInspectable
A CloudFormation AWS::CodeBuild::ReportGroup.

Represents a report group. A report group contains a collection of reports.

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.*;
 CfnReportGroup cfnReportGroup = CfnReportGroup.Builder.create(this, "MyCfnReportGroup")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReportGroup

      protected CfnReportGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnReportGroup

      protected CfnReportGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnReportGroup

      @Stability(Stable) public CfnReportGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnReportGroupProps props)
      Create a new AWS::CodeBuild::ReportGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

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

    • getExportConfig

      @Stability(Stable) @NotNull public Object getExportConfig()
      Information about the destination where the raw data of this ReportGroup is exported.

    • setExportConfig

      @Stability(Stable) public void setExportConfig(@NotNull IResolvable value)
      Information about the destination where the raw data of this ReportGroup is exported.

    • setExportConfig

      @Stability(Stable) public void setExportConfig(@NotNull CfnReportGroup.ReportExportConfigProperty value)
      Information about the destination where the raw data of this ReportGroup is exported.

    • getType

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

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      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

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

    • setDeleteReports

      @Stability(Stable) public void setDeleteReports(@Nullable Boolean value)
      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.

    • setDeleteReports

      @Stability(Stable) public void setDeleteReports(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public String getName()
      The name of the ReportGroup .

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the ReportGroup .