class CfnCustomMetricPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.IoT.CfnCustomMetricPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsiot#CfnCustomMetricPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.iot.CfnCustomMetricPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_iot.CfnCustomMetricPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_iot » CfnCustomMetricPropsMixin

Implements IMixin

Extends Mixin

Use the AWS::IoT::CustomMetric resource to define a custom metric published by your devices to Device Defender.

For API reference, see CreateCustomMetric and for general information, see Custom metrics .

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 { aws_iot as iot } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnCustomMetricPropsMixin = new iot.CfnCustomMetricPropsMixin({
  displayName: 'displayName',
  metricName: 'metricName',
  metricType: 'metricType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnCustomMetricPropsMixin(props: CfnCustomMetricMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCustomMetricMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IoT::CustomMetric.

Properties

Name	Type	Description
props	CfnCustomMetricMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCustomMetricMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.