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

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

Overview

Note:

When making an API call, you may pass Behavior data as a hash:

{
  name: "BehaviorName", # required
  metric: "BehaviorMetric",
  metric_dimension: {
    dimension_name: "DimensionName", # required
    operator: "IN", # accepts IN, NOT_IN
  },
  criteria: {
    comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
    value: {
      count: 1,
      cidrs: ["Cidr"],
      ports: [1],
    },
    duration_seconds: 1,
    consecutive_datapoints_to_alarm: 1,
    consecutive_datapoints_to_clear: 1,
    statistical_threshold: {
      statistic: "EvaluationStatistic",
    },
  },
}

A Device Defender security profile behavior.

Instance Attribute Summary collapse

Instance Attribute Details

#criteriaTypes::BehaviorCriteria

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



1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1370

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria)
  include Aws::Structure
end

#metricString

What is measured by the behavior.

Returns:

  • (String)


1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1370

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria)
  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 only to MQTT topics whose name match the pattern specified in the dimension.



1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1370

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria)
  include Aws::Structure
end

#nameString

The name you have given to the behavior.

Returns:

  • (String)


1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1370

class Behavior < Struct.new(
  :name,
  :metric,
  :metric_dimension,
  :criteria)
  include Aws::Structure
end