AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoT::SecurityProfile

CfnSecurityProfile

Use the `AWS::IoT::SecurityProfile` resource to create a Device Defender security profile. For API reference, see [CreateSecurityProfile](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateSecurityProfile.html) and for general information, see [Detect](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) .

Import

import { CfnSecurityProfile } from 'aws-cdk-lib/aws-iot';

Or use the module namespace:

import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnSecurityProfile

Properties

Configuration passed to the constructor as CfnSecurityProfileProps.

additionalMetricsToRetainV2Optional
IResolvable | IResolvable | MetricToRetainProperty[]

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.

alertTargetsOptional
IResolvable | { [key: string]: IResolvable | AlertTargetProperty }

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.

behaviorsOptional
IResolvable | IResolvable | BehaviorProperty[]

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

metricsExportConfigOptional
IResolvable | MetricsExportConfigProperty

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

securityProfileDescriptionOptional
string

A description of the security profile.

securityProfileNameOptional
string

The name you gave to the security profile.

tagsOptional
CfnTag[]

Metadata that can be used to manage the security profile.

targetArnsOptional
string[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoT::SecurityProfileView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iot
CFN TypeAWS::IoT::SecurityProfile
Properties8

Related Constructs

Explore This Service

External Links