Interface CfnSecurityProfile.BehaviorProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSecurityProfile.BehaviorProperty.Jsii$Proxy
- Enclosing class:
CfnSecurityProfile
@Stability(Stable)
public static interface CfnSecurityProfile.BehaviorProperty
extends software.amazon.jsii.JsiiSerializable
A Device Defender security profile behavior.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; BehaviorProperty behaviorProperty = BehaviorProperty.builder() .name("name") // the properties below are optional .criteria(BehaviorCriteriaProperty.builder() .comparisonOperator("comparisonOperator") .consecutiveDatapointsToAlarm(123) .consecutiveDatapointsToClear(123) .durationSeconds(123) .mlDetectionConfig(MachineLearningDetectionConfigProperty.builder() .confidenceLevel("confidenceLevel") .build()) .statisticalThreshold(StatisticalThresholdProperty.builder() .statistic("statistic") .build()) .value(MetricValueProperty.builder() .cidrs(List.of("cidrs")) .count("count") .number(123) .numbers(List.of(123)) .ports(List.of(123)) .strings(List.of("strings")) .build()) .build()) .exportMetric(false) .metric("metric") .metricDimension(MetricDimensionProperty.builder() .dimensionName("dimensionName") // the properties below are optional .operator("operator") .build()) .suppressAlerts(false) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnSecurityProfile.BehaviorProperty
static final class
An implementation forCfnSecurityProfile.BehaviorProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The criteria that determine if a device is behaving normally in regard to themetric
.default Object
Value indicates exporting metrics related to the behavior when it is true.default String
What is measured by the behavior.default Object
The dimension of the metric.getName()
The name you've given to the behavior.default Object
The alert status.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name you've given to the behavior.- See Also:
-
getCriteria
The criteria that determine if a device is behaving normally in regard to themetric
.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.
- See Also:
-
getExportMetric
Value indicates exporting metrics related to the behavior when it is true.- See Also:
-
getMetric
What is measured by the behavior.- See Also:
-
getMetricDimension
The dimension of the metric.- See Also:
-
getSuppressAlerts
The alert status.If you set the value to
true
, alerts will be suppressed.- See Also:
-
builder
-