software.amazon.awscdk.services.codebuild

Class CfnReportGroup

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:24.172Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReportGroup(Construct scope, java.lang.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
java.lang.String	getAttrArn() The ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
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.
java.lang.String	getName() The name of the `ReportGroup` .
TagManager	getTags() A list of tag key and value pairs associated with this report group.
java.lang.String	getType() The type of the `ReportGroup` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDeleteReports(java.lang.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(java.lang.String value) The name of the `ReportGroup` .
void	setType(java.lang.String value) The type of the `ReportGroup` .

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnReportGroup(Construct scope,
                      java.lang.String id,
                      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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.lang.Object getExportConfig()

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

setExportConfig

public void setExportConfig(IResolvable value)

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

setExportConfig

public void setExportConfig(CfnReportGroup.ReportExportConfigProperty value)

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

getType

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

setType

public void setType(java.lang.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

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

setDeleteReports

public void setDeleteReports(java.lang.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

public void setDeleteReports(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

public java.lang.String getName()

The name of the `ReportGroup` .

setName

public void setName(java.lang.String value)

The name of the `ReportGroup` .