CfnCustomMetricProps
- class aws_cdk.aws_iot.CfnCustomMetricProps(*, metric_type, display_name=None, metric_name=None, tags=None)
Bases:
object
Properties for defining a
CfnCustomMetric
.- Parameters:
metric_type (
str
) – The type of the custom metric. Types includestring-list
,ip-address-list
,number-list
, andnumber
. .. epigraph:: The typenumber
only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.display_name (
Optional
[str
]) – The friendly name in the console for the custom metric. This name doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.metric_name (
Optional
[str
]) – The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can’t begin withaws:
. You can’t change the name after you define it.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Metadata that can be used to manage the custom metric.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iot as iot cfn_custom_metric_props = iot.CfnCustomMetricProps( metric_type="metricType", # the properties below are optional display_name="displayName", metric_name="metricName", tags=[CfnTag( key="key", value="value" )] )
Attributes
- display_name
The friendly name in the console for the custom metric.
This name doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
- metric_name
The name of the custom metric.
This will be used in the metric report submitted from the device/thing. The name can’t begin with
aws:
. You can’t change the name after you define it.
- metric_type
The type of the custom metric. Types include
string-list
,ip-address-list
,number-list
, andnumber
.The type
number
only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
- tags
Metadata that can be used to manage the custom metric.