Package software.amazon.awscdk.services.codebuild

Class CfnReportGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codebuild.CfnReportGroup
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IReportGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:00.618Z") @Stability(Stable) public class CfnReportGroup extends CfnResource implements IInspectable, IReportGroupRef, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnReportGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getReportGroupRef

      @Stability(Stable) @NotNull public ReportGroupReference getReportGroupRef()
      A reference to a ReportGroup resource.
      Specified by:
      getReportGroupRef in interface IReportGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getExportConfig

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

      Returns union: either IResolvable or CfnReportGroup.ReportExportConfigProperty

    • 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:.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the ReportGroup .

      This can be one of the following values:.

    • getDeleteReports

      @Stability(Stable) @Nullable public Object getDeleteReports()
      When deleting a report group, specifies if reports within the report group should be deleted.

      Returns union: either Boolean or IResolvable

    • setDeleteReports

      @Stability(Stable) public void setDeleteReports(@Nullable Boolean value)
      When deleting a report group, specifies if reports within the report group should be deleted.

    • setDeleteReports

      @Stability(Stable) public void setDeleteReports(@Nullable IResolvable value)
      When deleting a report group, specifies if reports within the report group should be deleted.

    • 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 .

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tag key and value pairs associated with this report group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tag key and value pairs associated with this report group.