software.amazon.awscdk.services.iot

Interface CfnCustomMetricProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomMetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:10.169Z")
 @Stability(value=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

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCustomMetricProps.Builder A builder for CfnCustomMetricProps
static class	CfnCustomMetricProps.Jsii$Proxy An implementation for CfnCustomMetricProps

Method Summary

Modifier and Type	Method and Description
static CfnCustomMetricProps.Builder	builder()
default String	getDisplayName() Field that represents a friendly name in the console for the custom metric;
default String	getMetricName() The name of the custom metric.
String	getMetricType() The type of the custom metric.
default List<CfnTag>	getTags() Metadata that can be used to manage the custom metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricType

@Stability(value=Stable)
 @NotNull
String getMetricType()

The type of the custom metric.

Types include string-list , ip-address-list , number-list , and number .

getDisplayName

@Stability(value=Stable)
 @Nullable
default String getDisplayName()

Field that represents a friendly name in the console for the custom metric;

it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

getMetricName

@Stability(value=Stable)
 @Nullable
default String getMetricName()

The name of the custom metric.

This will be used in the metric report submitted from the device/thing. It shouldn't begin with aws: . Cannot be updated once it's defined.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the custom metric.

builder

@Stability(value=Stable)
static CfnCustomMetricProps.Builder builder()

Returns:

a CfnCustomMetricProps.Builder of CfnCustomMetricProps