Interface CfnCustomMetricProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCustomMetricProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:29:57.534Z")
@Stability(Stable)
public interface CfnCustomMetricProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnCustomMetric
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; CfnCustomMetricProps cfnCustomMetricProps = CfnCustomMetricProps.builder() .metricType("metricType") // the properties below are optional .displayName("displayName") .metricName("metricName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCustomMetricProps
static final class
An implementation forCfnCustomMetricProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnCustomMetricProps.Builder
builder()
default String
The friendly name in the console for the custom metric.default String
The name of the custom metric.The type of the custom metric.getTags()
Metadata that can be used to manage the custom metric.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMetricType
The type of the custom metric. Types includestring-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. -
getDisplayName
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.
-
getMetricName
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. -
getTags
Metadata that can be used to manage the custom metric. -
builder
- Returns:
- a
CfnCustomMetricProps.Builder
ofCfnCustomMetricProps
-