interface CfnReportGroupProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeBuild.CfnReportGroupProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#CfnReportGroupProps |
![]() | software.amazon.awscdk.services.codebuild.CfnReportGroupProps |
![]() | aws_cdk.aws_codebuild.CfnReportGroupProps |
![]() | aws-cdk-lib » aws_codebuild » CfnReportGroupProps |
Properties for defining a CfnReportGroup
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnReportGroupProps: codebuild.CfnReportGroupProps = {
exportConfig: {
exportConfigType: 'exportConfigType',
// the properties below are optional
s3Destination: {
bucket: 'bucket',
// the properties below are optional
bucketOwner: 'bucketOwner',
encryptionDisabled: false,
encryptionKey: 'encryptionKey',
packaging: 'packaging',
path: 'path',
},
},
type: 'type',
// the properties below are optional
deleteReports: false,
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
export | IResolvable | Report | Information about the destination where the raw data of this ReportGroup is exported. |
type | string | The type of the ReportGroup . This can be one of the following values:. |
delete | boolean | IResolvable | When deleting a report group, specifies if reports within the report group should be deleted. |
name? | string | The name of the ReportGroup . |
tags? | Cfn [] | A list of tag key and value pairs associated with this report group. |
exportConfig
Type:
IResolvable
|
Report
Information about the destination where the raw data of this ReportGroup
is exported.
type
Type:
string
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.
deleteReports?
Type:
boolean |
IResolvable
(optional)
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.
name?
Type:
string
(optional)
The name of the ReportGroup
.
tags?
Type:
Cfn
[]
(optional)
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.