2.233.0

interface CfnCustomMetricMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnCustomMetricMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnCustomMetricMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.iot.mixins.CfnCustomMetricMixinProps
Pythonaws_cdk.mixins_preview.aws_iot.mixins.CfnCustomMetricMixinProps
TypeScript @aws-cdk/mixins-preview » aws_iot » mixins » CfnCustomMetricMixinProps

Properties for CfnCustomMetricPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
const cfnCustomMetricMixinProps: iot_mixins.CfnCustomMetricMixinProps = {
  displayName: 'displayName',
  metricName: 'metricName',
  metricType: 'metricType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
displayName?stringThe friendly name in the console for the custom metric.
metricName?stringThe name of the custom metric.
metricType?stringThe type of the custom metric. Types include string-list , ip-address-list , number-list , and number .
tags?CfnTag[]Metadata that can be used to manage the custom metric.

displayName?

Type: string (optional)

The friendly name in the console for the custom metric.

This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-displayname

metricName?

Type: string (optional)

The name of the custom metric.

This will be used in the metric report submitted from the device/thing. The name can't begin with aws: . You can’t change the name after you define it.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-metricname

metricType?

Type: string (optional)

The type of the custom metric. Types include string-list , ip-address-list , number-list , and number .

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-metrictype

tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the custom metric.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html#cfn-iot-custommetric-tags

← PreviousNext →