Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iot-securityprofile.json
Parent schema serverless-framework-configuration
Type: object

A security profile defines a set of expected behaviors for devices in your account.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git

Properties

SecurityProfileName string | Aws_CF_FunctionString

A unique identifier for the security profile.

SecurityProfileDescription string | Aws_CF_FunctionString

A description of the security profile.

Behaviors Behavior[]

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

maxLength=100uniqueItems=true
AlertTargets object

Specifies the destinations to which alerts are sent.

AdditionalMetricsToRetainV2 MetricToRetain[]

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 is also retained for any metric specified here.

uniqueItems=true
Tags Tag[]

Metadata that can be used to manage the security profile.

maxItems=50uniqueItems=true
TargetArns string[]

A set of target ARNs that the security profile is attached to.

uniqueItems=true

Definitions

Behavior object

A security profile behavior.

Name string | Aws_CF_FunctionString required

The name for the behavior.

Metric string | Aws_CF_FunctionString

What is measured by the behavior.

MetricDimension object

The dimension of a metric.

2 nested properties
DimensionName string | Aws_CF_FunctionString required

A unique identifier for the dimension.

Operator string | Aws_CF_FunctionString

Defines how the dimensionValues of a dimension are interpreted.

Criteria object

The criteria by which the behavior is determined to be normal.

7 nested properties
ComparisonOperator string | Aws_CF_FunctionString

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

Value object

The value to be compared with the metric.

6 nested properties
Count string | Aws_CF_FunctionString

If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.

Cidrs string[]

If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

uniqueItems=true
Ports integer[]

If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

uniqueItems=true
Number number

The numeral value of a metric.

Numbers number[]

The numeral values of a metric.

uniqueItems=true
Strings string[]

The string values of a metric.

uniqueItems=true
DurationSeconds integer

Use this to specify the time duration over which the behavior is evaluated.

ConsecutiveDatapointsToAlarm integer

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

min=1max=10
ConsecutiveDatapointsToClear integer

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

min=1max=10
StatisticalThreshold object

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

1 nested properties
Statistic string | Aws_CF_FunctionString

The percentile which resolves to a threshold value by which compliance with a behavior is determined

MlDetectionConfig object

The configuration of an ML Detect Security Profile.

1 nested properties
ConfidenceLevel string | Aws_CF_FunctionString

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

SuppressAlerts boolean

Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification.

MetricDimension object

The dimension of a metric.

DimensionName string | Aws_CF_FunctionString required

A unique identifier for the dimension.

Operator string | Aws_CF_FunctionString

Defines how the dimensionValues of a dimension are interpreted.

BehaviorCriteria object

The criteria by which the behavior is determined to be normal.

ComparisonOperator string | Aws_CF_FunctionString

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

Value object

The value to be compared with the metric.

6 nested properties
Count string | Aws_CF_FunctionString

If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.

Cidrs string[]

If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

uniqueItems=true
Ports integer[]

If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

uniqueItems=true
Number number

The numeral value of a metric.

Numbers number[]

The numeral values of a metric.

uniqueItems=true
Strings string[]

The string values of a metric.

uniqueItems=true
DurationSeconds integer

Use this to specify the time duration over which the behavior is evaluated.

ConsecutiveDatapointsToAlarm integer

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

min=1max=10
ConsecutiveDatapointsToClear integer

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

min=1max=10
StatisticalThreshold object

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

1 nested properties
Statistic string | Aws_CF_FunctionString

The percentile which resolves to a threshold value by which compliance with a behavior is determined

MlDetectionConfig object

The configuration of an ML Detect Security Profile.

1 nested properties
ConfidenceLevel string | Aws_CF_FunctionString

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

MetricValue object

The value to be compared with the metric.

Count string | Aws_CF_FunctionString

If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric.

Cidrs string[]

If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

uniqueItems=true
Ports integer[]

If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

uniqueItems=true
Number number

The numeral value of a metric.

Numbers number[]

The numeral values of a metric.

uniqueItems=true
Strings string[]

The string values of a metric.

uniqueItems=true
StatisticalThreshold object

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Statistic string | Aws_CF_FunctionString

The percentile which resolves to a threshold value by which compliance with a behavior is determined

MachineLearningDetectionConfig object

The configuration of an ML Detect Security Profile.

ConfidenceLevel string | Aws_CF_FunctionString

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

AlertTarget object

A structure containing the alert target ARN and the role ARN.

AlertTargetArn string | Aws_CF_FunctionString required

The ARN of the notification target to which alerts are sent.

RoleArn string | Aws_CF_FunctionString required

The ARN of the role that grants permission to send alerts to the notification target.

MetricToRetain object

The metric you want to retain. Dimensions are optional.

Metric string | Aws_CF_FunctionString required

What is measured by the behavior.

MetricDimension object

The dimension of a metric.

2 nested properties
DimensionName string | Aws_CF_FunctionString required

A unique identifier for the dimension.

Operator string | Aws_CF_FunctionString

Defines how the dimensionValues of a dimension are interpreted.

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The tag's key.

Value string | Aws_CF_FunctionString required

The tag's value.