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

#criteria ⇒ Types::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.

Returns:



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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

#export_metric ⇒ Boolean

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

Returns:

  • (Boolean) 


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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

#metric ⇒ String

What is measured by the behavior.

Returns:

  • (String) 


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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

#metric_dimension ⇒ Types::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.

Returns:



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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

#name ⇒ String

The name you've given to the behavior.

Returns:

  • (String) 


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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

#suppress_alerts ⇒ Boolean

Suppresses alerts.

Returns:

  • (Boolean) 


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1314

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