Package 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(Stable) public static final class ReportGroup.Builder extends Object implements software.amazon.jsii.Builder<ReportGroup>
A fluent builder for ReportGroup.

  • Method Details

    • create

      @Stability(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.

    • deleteReports

      @Stability(Stable) public ReportGroup.Builder deleteReports(Boolean deleteReports)
      If true, deleting the report group force deletes the contents of the report group.

      If false, the report group must be empty before attempting to delete it.

      Default: false

      Parameters:
      deleteReports - If true, deleting the report group force deletes the contents of the report group. This parameter is required.
      Returns:
      this

    • exportBucket

      @Stability(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(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(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(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(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 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(Stable) public ReportGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ReportGroup>
      Returns:
      a newly built instance of ReportGroup.