interface CfnFleetMetricProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnFleetMetricProps
Java	software.amazon.awscdk.services.iot.CfnFleetMetricProps
Python	aws_cdk.aws_iot.CfnFleetMetricProps
TypeScript	@aws-cdk/aws-iot » CfnFleetMetricProps

Properties for defining a CfnFleetMetric.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';
const cfnFleetMetricProps: iot.CfnFleetMetricProps = {
  metricName: 'metricName',

  // the properties below are optional
  aggregationField: 'aggregationField',
  aggregationType: {
    name: 'name',
    values: ['values'],
  },
  description: 'description',
  indexName: 'indexName',
  period: 123,
  queryString: 'queryString',
  queryVersion: 'queryVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  unit: 'unit',
};

Properties

Name	Type	Description
metricName	string	The name of the fleet metric to create.
aggregationField?	string	The field to aggregate.
aggregationType?	IResolvable | AggregationTypeProperty	The type of the aggregation query.
description?	string	The fleet metric description.
indexName?	string	The name of the index to search.
period?	number	The time in seconds between fleet metric emissions.
queryString?	string	The search query string.
queryVersion?	string	The query version.
tags?	CfnTag[]	Metadata which can be used to manage the fleet metric.
unit?	string	Used to support unit transformation such as milliseconds to seconds.

---

metricName

Type: string

The name of the fleet metric to create.

---

aggregationField?

Type: string (optional)

The field to aggregate.

---

aggregationType?

Type: IResolvable | AggregationTypeProperty (optional)

The type of the aggregation query.

---

description?

Type: string (optional)

The fleet metric description.

---

indexName?

Type: string (optional)

The name of the index to search.

---

period?

Type: number (optional)

The time in seconds between fleet metric emissions.

Range [60(1 min), 86400(1 day)] and must be multiple of 60.

---

queryString?

Type: string (optional)

The search query string.

---

queryVersion?

Type: string (optional)

The query version.

---

tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the fleet metric.

---

unit?

Type: string (optional)

Used to support unit transformation such as milliseconds to seconds.

Must be a unit supported by CW metric. Default to null.