Interface CfnCustomMetricProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.534Z") @Stability(Stable) public interface CfnCustomMetricProps extends
Properties for defining a CfnCustomMetric.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnCustomMetricProps cfnCustomMetricProps = CfnCustomMetricProps.builder()
         // the properties below are optional
  • Method Details

    • getMetricType

      @Stability(Stable) @NotNull String getMetricType()
      The type of the custom metric. Types include string-list , ip-address-list , number-list , and number .

      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

      @Stability(Stable) @Nullable default String 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

      @Stability(Stable) @Nullable default String 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

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Metadata that can be used to manage the custom metric.
    • builder

      @Stability(Stable) static CfnCustomMetricProps.Builder builder()
      a CfnCustomMetricProps.Builder of CfnCustomMetricProps