Package software.amazon.awscdk.services.iot

Class CfnCustomMetric

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnCustomMetric
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICustomMetricRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.141Z") @Stability(Stable) public class CfnCustomMetric extends CfnResource implements IInspectable, ICustomMetricRef, ITaggable
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();

See Also:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCustomMetric

      @Stability(Stable) @NotNull public static String arnForCustomMetric(@NotNull ICustomMetricRef resource)
      Parameters:
      resource - This parameter is required.

    • fromMetricName

      @Stability(Stable) @NotNull public static ICustomMetricRef fromMetricName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String metricName)
      Creates a new ICustomMetricRef from a metricName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      metricName - This parameter is required.

    • isCfnCustomMetric

      @Stability(Stable) @NotNull public static Boolean isCfnCustomMetric(@NotNull Object x)
      Checks whether the given object is a CfnCustomMetric.

      Parameters:
      x - This parameter is required.

    • 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

    • getCustomMetricRef

      @Stability(Stable) @NotNull public CustomMetricReference getCustomMetricRef()
      A reference to a CustomMetric resource.
      Specified by:
      getCustomMetricRef in interface ICustomMetricRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getMetricType

      @Stability(Stable) @NotNull public String getMetricType()
      The type of the custom metric.

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

    • 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 .

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The friendly name in the console for the custom metric.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The friendly name in the console for the custom metric.

    • getMetricName

      @Stability(Stable) @Nullable public String getMetricName()
      The name of the custom metric.

    • setMetricName

      @Stability(Stable) public void setMetricName(@Nullable String value)
      The name of the custom metric.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata that can be used to manage the custom metric.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the custom metric.