ReportGroupProps

class aws_cdk.aws_codebuild.ReportGroupProps(*, export_bucket=None, removal_policy=None, report_group_name=None, zip_export=None)

Bases: object

Construction properties for {@link ReportGroup}.

Parameters:

  • export_bucket (Optional[IBucket]) – An optional S3 bucket to export the reports to. Default: - the reports will not be exported

  • removal_policy (Optional[RemovalPolicy]) – 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. Default: RemovalPolicy.RETAIN

  • report_group_name (Optional[str]) – The physical name of the report group. Default: - CloudFormation-generated name

  • zip_export (Optional[bool]) – 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. Default: - false (the files will not be ZIPped)

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codebuild as codebuild
import aws_cdk.aws_s3 as s3
import aws_cdk.core as cdk

# bucket: s3.Bucket

report_group_props = codebuild.ReportGroupProps(
    export_bucket=bucket,
    removal_policy=cdk.RemovalPolicy.DESTROY,
    report_group_name="reportGroupName",
    zip_export=False
)

Attributes

export_bucket

An optional S3 bucket to export the reports to.

Default:

  • the reports will not be exported

removal_policy

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.

Default:

RemovalPolicy.RETAIN

report_group_name

The physical name of the report group.

Default:

  • CloudFormation-generated name

zip_export

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.

Default:

  • false (the files will not be ZIPped)