AWS Fundamentals Logo
AWS Fundamentals
AWS::IoT::CustomMetric

IoT CustomMetric

A custom metric published by your devices to Device Defender.

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
MetricType
string
RequiredCreate-only
DisplayName
string
MetricName
string
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
MetricArnstringThe Amazon Resource Number (ARN) of the custom metric.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoT::CustomMetric

Resources:
  MyResource:
    Type: AWS::IoT::CustomMetric
    Properties:
      MetricType: "string-list"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iot:CreateCustomMetriciot:TagResource

read

iot:DescribeCustomMetriciot:ListTagsForResource

update

iot:UpdateCustomMetriciot:ListTagsForResourceiot:UntagResourceiot:TagResource

delete

iot:DescribeCustomMetriciot:DeleteCustomMetric

list

iot:ListCustomMetrics

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoT
Properties5
Required1
TaggingSupported
Primary IDMetricName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

MetricNameMetricType

Related Resources

External Links