interface CfnSecurityProfileProps

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

Properties for defining a CfnSecurityProfile.

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 cfnSecurityProfileProps: iot.CfnSecurityProfileProps = {
  additionalMetricsToRetainV2: [{
    metric: 'metric',

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

      // the properties below are optional
      operator: 'operator',
    },
  }],
  alertTargets: {
    alertTargetsKey: {
      alertTargetArn: 'alertTargetArn',
      roleArn: 'roleArn',
    },
  },
  behaviors: [{
    name: 'name',

    // the properties below are optional
    criteria: {
      comparisonOperator: 'comparisonOperator',
      consecutiveDatapointsToAlarm: 123,
      consecutiveDatapointsToClear: 123,
      durationSeconds: 123,
      mlDetectionConfig: {
        confidenceLevel: 'confidenceLevel',
      },
      statisticalThreshold: {
        statistic: 'statistic',
      },
      value: {
        cidrs: ['cidrs'],
        count: 'count',
        number: 123,
        numbers: [123],
        ports: [123],
        strings: ['strings'],
      },
    },
    exportMetric: false,
    metric: 'metric',
    metricDimension: {
      dimensionName: 'dimensionName',

      // the properties below are optional
      operator: 'operator',
    },
    suppressAlerts: false,
  }],
  metricsExportConfig: {
    mqttTopic: 'mqttTopic',
    roleArn: 'roleArn',
  },
  securityProfileDescription: 'securityProfileDescription',
  securityProfileName: 'securityProfileName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetArns: ['targetArns'],
};

Properties

Name	Type	Description
additionalMetricsToRetainV2?	`IResolvable` `\|` `IResolvable` `\|` `MetricToRetainProperty[]`	A list of metrics whose data is retained (stored).
alertTargets?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `AlertTargetProperty` `}`	Specifies the destinations to which alerts are sent.
behaviors?	`IResolvable` `\|` `IResolvable` `\|` `BehaviorProperty[]`	Specifies the behaviors that, when violated by a device (thing), cause an alert.
metricsExportConfig?	`IResolvable` `\|` `MetricsExportConfigProperty`	Specifies the MQTT topic and role ARN required for metric export.
securityProfileDescription?	`string`	A description of the security profile.
securityProfileName?	`string`	The name you gave to the security profile.
tags?	`CfnTag[]`	Metadata that can be used to manage the security profile.
targetArns?	`string[]`	The ARN of the target (thing group) to which the security profile is attached.

additionalMetricsToRetainV2?

Type: IResolvable | IResolvable | MetricToRetainProperty[] (optional)

A list of metrics whose data is retained (stored).

By default, data is retained for any metric used in the profile's behaviors , but it's also retained for any metric specified here. Can be used with custom metrics; can't be used with dimensions.

alertTargets?

Type: IResolvable | { [string]: IResolvable | AlertTargetProperty } (optional)

Specifies the destinations to which alerts are sent.

(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

behaviors?

Type: IResolvable | IResolvable | BehaviorProperty[] (optional)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

metricsExportConfig?

Type: IResolvable | MetricsExportConfigProperty (optional)

Specifies the MQTT topic and role ARN required for metric export.

securityProfileDescription?

Type: string (optional)

A description of the security profile.

securityProfileName?

Type: string (optional)

The name you gave to the security profile.

tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the security profile.

targetArns?

Type: string[] (optional)

The ARN of the target (thing group) to which the security profile is attached.