ReportGroupProps

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

Bases: object

__init__(*, export_bucket=None, removal_policy=None, report_group_name=None, zip_export=None)

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)

Return type

None

Attributes

export_bucket

An optional S3 bucket to export the reports to.

default :default: - the reports will not be exported

Return type

Optional[IBucket]

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 :default: RemovalPolicy.RETAIN

Return type

Optional[RemovalPolicy]

report_group_name

The physical name of the report group.

default :default: - CloudFormation-generated name

Return type

Optional[str]

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 :default: - false (the files will not be ZIPped)

Return type

Optional[bool]