Class ReportGroupProps
Construction properties for ReportGroup
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ReportGroupProps : Object, IReportGroupProps
Syntax (vb)
Public Class ReportGroupProps
Inherits Object
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() |
Properties
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()
public ReportGroupProps()
Properties
ExportBucket
An optional S3 bucket to export the reports to.
public IBucket ExportBucket { get; set; }
Property Value
Remarks
Default: - the reports will not be exported
RemovalPolicy
What to do when this resource is deleted from a stack.
public Nullable<RemovalPolicy> RemovalPolicy { get; set; }
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.
public string ReportGroupName { get; set; }
Property Value
System.String
Remarks
Default: - CloudFormation-generated name
Type
The type of report group. This can be one of the following values:.
public Nullable<ReportGroupType> Type { get; set; }
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.
public Nullable<bool> ZipExport { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Ignored if exportBucket
has not been provided.
Default: - false (the files will not be ZIPped)