software.amazon.awscdk.services.codebuild

Class ReportGroup.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.ReportGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReportGroup>

Enclosing class:

ReportGroup

@Stability(value=Stable)
public static final class ReportGroup.Builder
extends Object
implements software.amazon.jsii.Builder<ReportGroup>

A fluent builder for ReportGroup.

Method Summary

Modifier and Type	Method and Description
ReportGroup	build()
static ReportGroup.Builder	create(software.constructs.Construct scope, String id)
ReportGroup.Builder	exportBucket(IBucket exportBucket) An optional S3 bucket to export the reports to.
ReportGroup.Builder	removalPolicy(RemovalPolicy removalPolicy) What to do when this resource is deleted from a stack.
ReportGroup.Builder	reportGroupName(String reportGroupName) The physical name of the report group.
ReportGroup.Builder	type(ReportGroupType type) The type of report group.
ReportGroup.Builder	zipExport(Boolean zipExport) Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ReportGroup.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ReportGroup.Builder.

exportBucket

@Stability(value=Stable)
public ReportGroup.Builder exportBucket(IBucket exportBucket)

An optional S3 bucket to export the reports to.

Default: - the reports will not be exported

Parameters:

exportBucket - An optional S3 bucket to export the reports to. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Stable)
public ReportGroup.Builder removalPolicy(RemovalPolicy 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

Parameters:

removalPolicy - What to do when this resource is deleted from a stack. This parameter is required.

Returns:

this

reportGroupName

@Stability(value=Stable)
public ReportGroup.Builder reportGroupName(String reportGroupName)

The physical name of the report group.

Default: - CloudFormation-generated name

Parameters:

reportGroupName - The physical name of the report group. This parameter is required.

Returns:

this

type

@Stability(value=Stable)
public ReportGroup.Builder type(ReportGroupType type)

The type of report group. This can be one of the following values:.

• TEST - The report group contains test reports.
• CODE_COVERAGE - The report group contains code coverage reports.

Default: TEST

Parameters:

type - The type of report group. This can be one of the following values:. This parameter is required.

Returns:

this

zipExport

@Stability(value=Stable)
public ReportGroup.Builder zipExport(Boolean zipExport)

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)

Parameters:

zipExport - Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ReportGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<ReportGroup>