Interface IReportGroupProps

Construction properties for ReportGroup.

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IReportGroupProps

Syntax (vb)

Public Interface IReportGroupProps

Remarks

ExampleMetadata: infused

Examples

Source source;


// create a new ReportGroup
var reportGroup = new ReportGroup(this, "ReportGroup", new ReportGroupProps {
    Type = ReportGroupType.CODE_COVERAGE
});

var project = new Project(this, "Project", new ProjectProps {
    Source = source,
    BuildSpec = BuildSpec.FromObject(new Dictionary<string, object> {
        // ...
        { "reports", new Dictionary<string, IDictionary<string, string>> {
            { reportGroup.ReportGroupArn, new Struct {
                Files = "**/*",
                Base-directory = "build/coverage-report.xml",
                File-format = "JACOCOXML"
            } }
        } }
    })
});

Synopsis

Properties

DeleteReports	If true, deleting the report group force deletes the contents of the report group.
ExportBucket	An optional S3 bucket to export the reports to.
RemovalPolicy	What to do when this resource is deleted from a stack.
ReportGroupName	The physical name of the report group.
Type	The type of report group. This can be one of the following values:.
ZipExport	Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.

Properties

DeleteReports

If true, deleting the report group force deletes the contents of the report group.

virtual Nullable<bool> DeleteReports { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: false

ExportBucket

An optional S3 bucket to export the reports to.

virtual IBucket ExportBucket { get; }

Property Value

IBucket

Remarks

Default: - the reports will not be exported

RemovalPolicy

What to do when this resource is deleted from a stack.

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }

Property Value

System.Nullable<RemovalPolicy>

Remarks

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

ReportGroupName

The physical name of the report group.

virtual string ReportGroupName { get; }

Property Value

System.String

Remarks

Default: - CloudFormation-generated name

Type

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

virtual Nullable<ReportGroupType> Type { get; }

Property Value

System.Nullable<ReportGroupType>

Remarks

Default: TEST

ZipExport

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

virtual Nullable<bool> ZipExport { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Ignored if exportBucket has not been provided.

Default: - false (the files will not be ZIPped)