@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-02T20:25:25.999Z")
public interface CfnCustomMetricProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnCustomMetricProps.Builder
A builder for
CfnCustomMetricProps |
static class |
CfnCustomMetricProps.Jsii$Proxy
An implementation for
CfnCustomMetricProps |
Modifier and Type | Method and Description |
---|---|
static CfnCustomMetricProps.Builder |
builder() |
default java.lang.String |
getDisplayName()
The friendly name in the console for the custom metric.
|
default java.lang.String |
getMetricName()
The name of the custom metric.
|
java.lang.String |
getMetricType()
The type of the custom metric.
|
default java.util.List<CfnTag> |
getTags()
Metadata that can be used to manage the custom metric.
|
java.lang.String getMetricType()
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.
default java.lang.String getDisplayName()
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.
default java.lang.String getMetricName()
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.
default java.util.List<CfnTag> getTags()
static CfnCustomMetricProps.Builder builder()
CfnCustomMetricProps.Builder
of CfnCustomMetricProps