interface MetricToRetainProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoT.CfnSecurityProfile.MetricToRetainProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnSecurityProfile_MetricToRetainProperty`
Java	`software.amazon.awscdk.services.iot.CfnSecurityProfile.MetricToRetainProperty`
Python	`aws_cdk.aws_iot.CfnSecurityProfile.MetricToRetainProperty`
TypeScript	`aws-cdk-lib` » `aws_iot` » `CfnSecurityProfile` » `MetricToRetainProperty`

The metric you want to retain.

Dimensions are optional.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.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-lib';
const metricToRetainProperty: iot.CfnSecurityProfile.MetricToRetainProperty = {
  metric: 'metric',

  // the properties below are optional
  exportMetric: false,
  metricDimension: {
    dimensionName: 'dimensionName',

    // the properties below are optional
    operator: 'operator',
  },
};

Properties

Name	Type	Description
metric	`string`	A standard of measurement.
exportMetric?	`boolean \|` `IResolvable`	The value indicates exporting metrics related to the `MetricToRetain` when it's true.
metricDimension?	`IResolvable` `\|` `MetricDimensionProperty`	The dimension of the metric.

metric

Type: string

A standard of measurement.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metric

exportMetric?

Type: boolean | IResolvable (optional)

The value indicates exporting metrics related to the MetricToRetain when it's true.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-exportmetric

metricDimension?

Type: IResolvable | MetricDimensionProperty (optional)

The dimension of the metric.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metricdimension