Class CfnGroup
Use the AWS::XRay::Group
resource to specify a group with a name and a filter expression.
Inherited Members
Namespace: Amazon.CDK.AWS.XRay
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGroup : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnGroup
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html
CloudformationResource: AWS::XRay::Group
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 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 [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnGroup(Construct, String, ICfnGroupProps) |
Properties
AttrGroupArn | The group ARN that was created or updated. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
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(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
CfnGroup(Construct, String, ICfnGroupProps)
public CfnGroup(Construct scope, string id, ICfnGroupProps 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 ICfnGroupProps
Resource properties.
Properties
AttrGroupArn
The group ARN that was created or updated.
public virtual string AttrGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GroupARN
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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
GroupName
The unique case-sensitive name of the group.
public virtual string GroupName { get; set; }
Property Value
System.String
InsightsConfiguration
The structure containing configurations related to insights.
public virtual object InsightsConfiguration { get; set; }
Property Value
System.Object
Tags
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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>