Package software.amazon.awscdk.services.iot

Class CfnCustomMetric

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnCustomMetric
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.532Z") @Stability(Stable) public class CfnCustomMetric extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::CustomMetric.

Use the AWS::IoT::CustomMetric resource to define a custom metric published by your devices to Device Defender. For API reference, see CreateCustomMetric and for general information, see Custom metrics .

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.*;
 CfnCustomMetric cfnCustomMetric = CfnCustomMetric.Builder.create(this, "MyCfnCustomMetric")
         .metricType("metricType")
         // the properties below are optional
         .displayName("displayName")
         .metricName("metricName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomMetric

      protected CfnCustomMetric(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomMetric

      protected CfnCustomMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomMetric

      @Stability(Stable) public CfnCustomMetric(@NotNull Construct scope, @NotNull String id, @NotNull CfnCustomMetricProps props)
      Create a new AWS::IoT::CustomMetric.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrMetricArn

      @Stability(Stable) @NotNull public String getAttrMetricArn()
      The Amazon Resource Number (ARN) of the custom metric;

      for example, arn: *aws-partition* :iot: *region* : *accountId* :custommetric/ *metricName* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the custom metric.

    • getMetricType

      @Stability(Stable) @NotNull public 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.

    • setMetricType

      @Stability(Stable) public void setMetricType(@NotNull String value)
      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 public 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.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      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 public 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.

    • setMetricName

      @Stability(Stable) public void setMetricName(@Nullable String value)
      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.