Class: Aws::IoT::Types::Behavior

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

A Device Defender security profile behavior.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#criteriaTypes::BehaviorCriteria

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

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



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end

#export_metricBoolean

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

Returns:

  • (Boolean)


1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end

#metricString

What is measured by the behavior.

Returns:

  • (String)


1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end

#metric_dimensionTypes::MetricDimension

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name you've given to the behavior.

Returns:

  • (String)


1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end

#suppress_alertsBoolean

Suppresses alerts.

Returns:

  • (Boolean)


1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1373

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria,
  :suppress_alerts,
  :export_metric)
  SENSITIVE = []
  include Aws::Structure
end