@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:24.172Z") public class CfnReportGroup extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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` .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnReportGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnReportGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnReportGroup(Construct scope, java.lang.String id, CfnReportGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
public java.lang.Object getExportConfig()
public void setExportConfig(IResolvable value)
public void setExportConfig(CfnReportGroup.ReportExportConfigProperty value)
public java.lang.String getType()
public void setType(java.lang.String value)
public java.lang.Object getDeleteReports()
public void setDeleteReports(java.lang.Boolean value)
public void setDeleteReports(IResolvable value)
public java.lang.String getName()
public void setName(java.lang.String value)