Class CfnCustomMetric
Use the AWS::IoT::CustomMetric
resource to define a custom metric published by your devices to Device Defender.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCustomMetric : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCustomMetric
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For API reference, see CreateCustomMetric and for general information, see Custom metrics .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html
CloudformationResource: AWS::IoT::CustomMetric
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.IoT;
var cfnCustomMetric = new CfnCustomMetric(this, "MyCfnCustomMetric", new CfnCustomMetricProps {
MetricType = "metricType",
// the properties below are optional
DisplayName = "displayName",
MetricName = "metricName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCustomMetric(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCustomMetric(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCustomMetric(Construct, String, ICfnCustomMetricProps) |
Properties
AttrMetricArn | The Amazon Resource Number (ARN) of the custom metric; |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DisplayName | The friendly name in the console for the custom metric. |
MetricName | The name of the custom metric. |
MetricType | The type of the custom metric. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Metadata that can be used to manage the custom metric. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCustomMetric(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCustomMetric(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCustomMetric(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCustomMetric(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCustomMetric(Construct, String, ICfnCustomMetricProps)
public CfnCustomMetric(Construct scope, string id, ICfnCustomMetricProps 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 ICfnCustomMetricProps
Resource properties.
Properties
AttrMetricArn
The Amazon Resource Number (ARN) of the custom metric;
public virtual string AttrMetricArn { get; }
Property Value
System.String
Remarks
for example, arn: aws-partition :iot: region : accountId :custommetric/ metricName
.
CloudformationAttribute: MetricArn
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
DisplayName
The friendly name in the console for the custom metric.
public virtual string DisplayName { get; set; }
Property Value
System.String
MetricName
The name of the custom metric.
public virtual string MetricName { get; set; }
Property Value
System.String
MetricType
The type of the custom metric.
public virtual string MetricType { get; set; }
Property Value
System.String
Remarks
Types include string-list
, ip-address-list
, number-list
, and number
.
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Metadata that can be used to manage the custom metric.
public virtual ICfnTag[] TagsRaw { 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>