AWS::IoT::SecurityProfile Behavior

A Device Defender security profile behavior.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Criteria" : BehaviorCriteria,
  "ExportMetric" : Boolean,
  "Metric" : String,
  "MetricDimension" : MetricDimension,
  "Name" : String,
  "SuppressAlerts" : Boolean
}

YAML

  Criteria: 
    BehaviorCriteria
  ExportMetric: Boolean
  Metric: String
  MetricDimension: 
    MetricDimension
  Name: String
  SuppressAlerts: Boolean

Properties

Criteria

The criteria that determine if a device is behaving normally in regard to the metric.

Note

In the AWS IoT console, you can choose to be sent an alert through Amazon SNS when AWS IoT Device Defender detects that a device is behaving anomalously.

Required: No

Type: BehaviorCriteria

Update requires: No interruption

ExportMetric

Value indicates exporting metrics related to the behavior when it is true.

Required: No

Type: Boolean

Update requires: No interruption

Metric

What is measured by the behavior.

Required: No

Type: String

Pattern: [a-zA-Z0-9:_-]+

Minimum: 1

Maximum: 128

Update requires: No interruption

MetricDimension

The dimension of the metric.

Required: No

Type: MetricDimension

Update requires: No interruption

Name

The name you've given to the behavior.

Required: Yes

Type: String

Pattern: [a-zA-Z0-9:_-]+

Minimum: 1

Maximum: 128

Update requires: No interruption

SuppressAlerts

The alert status. If you set the value to true, alerts will be suppressed.

Required: No

Type: Boolean

Update requires: No interruption