Show / Hide Table of Contents

Class ReportGroup

The ReportGroup resource class.

Inheritance
object
Resource
ReportGroup
Implements
IReportGroup
IResource
IConstruct
IDependable
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ReportGroup : Resource, IReportGroup, IResource, IConstruct, IDependable
Syntax (vb)
Public Class ReportGroup Inherits Resource Implements IReportGroup, IResource, IConstruct, IDependable
Remarks

ExampleMetadata: infused

Examples
Source source;


            // create a new ReportGroup
            var reportGroup = new ReportGroup(this, "ReportGroup");

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

Synopsis

Constructors

ReportGroup(Construct, string, IReportGroupProps?)

The ReportGroup resource class.

Properties

ExportBucket

The ReportGroup resource class.

PROPERTY_INJECTION_ID

Uniquely identifies this class.

ReportGroupArn

The ARN of the ReportGroup.

ReportGroupName

The name of the ReportGroup.

Type

The ReportGroup resource class.

Methods

FromReportGroupName(Construct, string, string)

Reference an existing ReportGroup, defined outside of the CDK code, by name.

GrantWrite(IGrantable)

Grants the given entity permissions to write (that is, upload reports to) this report group.

Constructors

ReportGroup(Construct, string, IReportGroupProps?)

The ReportGroup resource class.

public ReportGroup(Construct scope, string id, IReportGroupProps? props = null)
Parameters
scope Construct
id string
props IReportGroupProps
Remarks

ExampleMetadata: infused

Examples
Source source;


            // create a new ReportGroup
            var reportGroup = new ReportGroup(this, "ReportGroup");

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

Properties

ExportBucket

The ReportGroup resource class.

protected virtual IBucket? ExportBucket { get; }
Property Value

IBucket

Remarks

ExampleMetadata: infused

Examples
Source source;


            // create a new ReportGroup
            var reportGroup = new ReportGroup(this, "ReportGroup");

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

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

ExampleMetadata: infused

ReportGroupArn

The ARN of the ReportGroup.

public virtual string ReportGroupArn { get; }
Property Value

string

Remarks

ExampleMetadata: infused

ReportGroupName

The name of the ReportGroup.

public virtual string ReportGroupName { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Type

The ReportGroup resource class.

protected virtual ReportGroupType? Type { get; }
Property Value

ReportGroupType?

Remarks

ExampleMetadata: infused

Examples
Source source;


            // create a new ReportGroup
            var reportGroup = new ReportGroup(this, "ReportGroup");

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

Methods

FromReportGroupName(Construct, string, string)

Reference an existing ReportGroup, defined outside of the CDK code, by name.

public static IReportGroup FromReportGroupName(Construct scope, string id, string reportGroupName)
Parameters
scope Construct
id string
reportGroupName string
Returns

IReportGroup

Remarks

ExampleMetadata: infused

GrantWrite(IGrantable)

Grants the given entity permissions to write (that is, upload reports to) this report group.

public virtual Grant GrantWrite(IGrantable identity)
Parameters
identity IGrantable
Returns

Grant

Remarks

ExampleMetadata: infused

Implements

IReportGroup
IResource
Constructs.IConstruct
Constructs.IDependable
Back to top Generated by DocFX