Class ReportGroupProps

Construction properties for ReportGroup.

Inheritance

object

ReportGroupProps

Implements

IReportGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ReportGroupProps : IReportGroupProps

Syntax (vb)

Public Class ReportGroupProps Implements 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

Constructors

ReportGroupProps()

Construction properties for ReportGroup.

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.

Constructors

ReportGroupProps()

Construction properties for ReportGroup.

public ReportGroupProps()

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"
                        } }
                    } }
                })
            });

Properties

DeleteReports

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

public bool? DeleteReports { get; set; }

Property Value

bool?

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.

public IBucket? ExportBucket { get; set; }

Property Value

IBucket

Remarks

Default: - the reports will not be exported

RemovalPolicy

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

public RemovalPolicy? RemovalPolicy { get; set; }

Property Value

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.

public string? ReportGroupName { get; set; }

Property Value

string

Remarks

Default: - CloudFormation-generated name

Type

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

public ReportGroupType? Type { get; set; }

Property Value

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.

public bool? ZipExport { get; set; }

Property Value

bool?

Remarks

Ignored if exportBucket has not been provided.

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

Implements

IReportGroupProps