Class CfnGroup
A CloudFormation AWS::XRay::Group
.
Inherited Members
Namespace: Amazon.CDK.AWS.XRay
Assembly: Amazon.CDK.AWS.XRay.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::XRay::Group
resource to specify a group with a name and a filter expression. Groups enable the collection of traces that match the filter expression, can be used to filter service graphs and traces, and to supply Amazon CloudWatch metrics.
CloudformationResource: AWS::XRay::Group
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html
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.XRay;
var tags;
var cfnGroup = new CfnGroup(this, "MyCfnGroup", new CfnGroupProps {
GroupName = "groupName",
// the properties below are optional
FilterExpression = "filterExpression",
InsightsConfiguration = new InsightsConfigurationProperty {
InsightsEnabled = false,
NotificationsEnabled = false
},
Tags = new [] { tags }
});
Synopsis
Constructors
CfnGroup(Construct, String, ICfnGroupProps) | Create a new |
CfnGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrGroupArn | The group ARN that was created or updated. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
FilterExpression | The filter expression defining the parameters to include traces. |
GroupName | The unique case-sensitive name of the group. |
InsightsConfiguration | The structure containing configurations related to insights. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGroup(Construct, String, ICfnGroupProps)
Create a new AWS::XRay::Group
.
public CfnGroup(Construct scope, string id, ICfnGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGroupProps
- resource properties.
CfnGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrGroupArn
The group ARN that was created or updated.
public virtual string AttrGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GroupARN
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
FilterExpression
The filter expression defining the parameters to include traces.
public virtual string FilterExpression { get; set; }
Property Value
System.String
Remarks
GroupName
The unique case-sensitive name of the group.
public virtual string GroupName { get; set; }
Property Value
System.String
Remarks
InsightsConfiguration
The structure containing configurations related to insights.
public virtual object InsightsConfiguration { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual object[] Tags { get; set; }
Property Value
System.Object[]
Remarks
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>