aws-cdk-lib.aws_iot.CfnFleetMetricProps

interface CfnFleetMetricProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnFleetMetricProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnFleetMetricProps
Javasoftware.amazon.awscdk.services.iot.CfnFleetMetricProps
Pythonaws_cdk.aws_iot.CfnFleetMetricProps
TypeScript aws-cdk-lib » 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 { aws_iot as iot } from 'aws-cdk-lib';
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

NameTypeDescription
metricNamestringThe name of the fleet metric to create.
aggregationField?stringThe field to aggregate.
aggregationType?IResolvable | AggregationTypePropertyThe type of the aggregation query.
description?stringThe fleet metric description.
indexName?stringThe name of the index to search.
period?numberThe time in seconds between fleet metric emissions.
queryString?stringThe search query string.
queryVersion?stringThe query version.
tags?CfnTag[]Metadata which can be used to manage the fleet metric.
unit?stringUsed 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.