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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.325Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnReportGroup.Builder A fluent builder for CfnReportGroup.
static interface	CfnReportGroup.ReportExportConfigProperty Information about the location where the run of a report is exported.
static interface	CfnReportGroup.S3ReportExportConfigProperty Information about the S3 bucket where the raw data of a report are exported.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReportGroup(software.constructs.Construct scope, String id, CfnReportGroupProps props) Create a new `AWS::CodeBuild::ReportGroup`.
protected	CfnReportGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReportGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName` .
protected Map<String,Object>	getCfnProperties()
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.
String	getName() The name of the `ReportGroup` .
TagManager	getTags() A list of tag key and value pairs associated with this report group.
String	getType() The type of the `ReportGroup` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeleteReports(Boolean value) When deleting a report group, specifies if reports within the report group should be deleted.
void	setDeleteReports(IResolvable value) When deleting a report group, specifies if reports within the report group should be deleted.
void	setExportConfig(CfnReportGroup.ReportExportConfigProperty value) Information about the destination where the raw data of this `ReportGroup` is exported.
void	setExportConfig(IResolvable value) Information about the destination where the raw data of this `ReportGroup` is exported.
void	setName(String value) The name of the `ReportGroup` .
void	setType(String value) The type of the `ReportGroup` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReportGroup

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

CfnReportGroup

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

CfnReportGroup

@Stability(value=Stable)
public CfnReportGroup(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public Object getExportConfig()

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

setExportConfig

@Stability(value=Stable)
public void setExportConfig(@NotNull
                                                     CfnReportGroup.ReportExportConfigProperty value)

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

setExportConfig

@Stability(value=Stable)
public void setExportConfig(@NotNull
                                                     IResolvable value)

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

getType

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getName()

The name of the `ReportGroup` .

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the `ReportGroup` .