Class CfnReportGroup
Represents a report group.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReportGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnReportGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A report group contains a collection of reports.
CloudformationResource: AWS::CodeBuild::ReportGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;
var cfnReportGroup = new CfnReportGroup(this, "MyCfnReportGroup", new CfnReportGroupProps {
ExportConfig = new ReportExportConfigProperty {
ExportConfigType = "exportConfigType",
// the properties below are optional
S3Destination = new S3ReportExportConfigProperty {
Bucket = "bucket",
// the properties below are optional
BucketOwner = "bucketOwner",
EncryptionDisabled = false,
EncryptionKey = "encryptionKey",
Packaging = "packaging",
Path = "path"
}
},
Type = "type",
// the properties below are optional
DeleteReports = false,
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnReportGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReportGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnReportGroup(Construct, String, ICfnReportGroupProps) |
Properties
AttrArn | The ARN of the AWS CodeBuild report group, such as |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeleteReports | When deleting a report group, specifies if reports within the report group should be deleted. |
ExportConfig | Information about the destination where the raw data of this |
Name | The name of the |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of tag key and value pairs associated with this report group. |
Type | The type of the |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReportGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReportGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReportGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReportGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnReportGroup(Construct, String, ICfnReportGroupProps)
public CfnReportGroup(Construct scope, string id, ICfnReportGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnReportGroupProps
Resource properties.
Properties
AttrArn
The ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeleteReports
When deleting a report group, specifies if reports within the report group should be deleted.
public virtual object DeleteReports { get; set; }
Property Value
System.Object
ExportConfig
Information about the destination where the raw data of this ReportGroup
is exported.
public virtual object ExportConfig { get; set; }
Property Value
System.Object
Name
The name of the ReportGroup
.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of tag key and value pairs associated with this report group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Type
The type of the ReportGroup
.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
This can be one of the following values:.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>