interface ReportGroupProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeBuild.ReportGroupProps |
![]() | software.amazon.awscdk.services.codebuild.ReportGroupProps |
![]() | aws_cdk.aws_codebuild.ReportGroupProps |
![]() | @aws-cdk/aws-codebuild » ReportGroupProps |
Construction properties for {@link ReportGroup}.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codebuild from '@aws-cdk/aws-codebuild';
import * as s3 from '@aws-cdk/aws-s3';
import * as cdk from '@aws-cdk/core';
declare const bucket: s3.Bucket;
const reportGroupProps: codebuild.ReportGroupProps = {
exportBucket: bucket,
removalPolicy: cdk.RemovalPolicy.DESTROY,
reportGroupName: 'reportGroupName',
zipExport: false,
};
Properties
Name | Type | Description |
---|---|---|
export | IBucket | An optional S3 bucket to export the reports to. |
removal | Removal | What to do when this resource is deleted from a stack. |
report | string | The physical name of the report group. |
zip | boolean | Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export. |
exportBucket?
Type:
IBucket
(optional, default: the reports will not be exported)
An optional S3 bucket to export the reports to.
removalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.RETAIN)
What to do when this resource is deleted from a stack.
As CodeBuild does not allow deleting a ResourceGroup that has reports inside of it, this is set to retain the resource by default.
reportGroupName?
Type:
string
(optional, default: CloudFormation-generated name)
The physical name of the report group.
zipExport?
Type:
boolean
(optional, default: false (the files will not be ZIPped))
Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.
Ignored if {@link exportBucket} has not been provided.