AWS::IoT::FleetMetricCfnFleetMetric
Use the `AWS::IoT::FleetMetric` resource to declare a fleet metric.
Import
import { CfnFleetMetric } from 'aws-cdk-lib/aws-iot';Or use the module namespace:
import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnFleetMetricProperties
Configuration passed to the constructor as CfnFleetMetricProps.
metricNameRequiredstringThe name of the fleet metric to create.
aggregationFieldOptionalstringThe field to aggregate.
aggregationTypeOptionalIResolvable | AggregationTypePropertyThe type of the aggregation query.
descriptionOptionalstringThe fleet metric description.
indexNameOptionalstringThe name of the index to search.
periodOptionalnumberThe time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
queryStringOptionalstringThe search query string.
queryVersionOptionalstringThe query version.
tagsOptionalCfnTag[]Metadata which can be used to manage the fleet metric.
unitOptionalstringUsed to support unit transformation such as milliseconds to seconds. Must be a unit supported by CW metric. Default to null.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-iotAWS::IoT::FleetMetric