software.amazon.awscdk.services.iot

Interface CfnSecurityProfile.BehaviorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityProfile.BehaviorProperty.Jsii$Proxy

Enclosing class:

CfnSecurityProfile

@Stability(value=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())
         .metric("metric")
         .metricDimension(MetricDimensionProperty.builder()
                 .dimensionName("dimensionName")
                 // the properties below are optional
                 .operator("operator")
                 .build())
         .suppressAlerts(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSecurityProfile.BehaviorProperty.Builder A builder for CfnSecurityProfile.BehaviorProperty
static class	CfnSecurityProfile.BehaviorProperty.Jsii$Proxy An implementation for CfnSecurityProfile.BehaviorProperty

Method Summary

Modifier and Type	Method and Description
static CfnSecurityProfile.BehaviorProperty.Builder	builder()
default Object	getCriteria() The criteria that determine if a device is behaving normally in regard to the `metric` .
default String	getMetric() What is measured by the behavior.
default Object	getMetricDimension() The dimension of the metric.
String	getName() The name you've given to the behavior.
default Object	getSuppressAlerts() The alert status.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name you've given to the behavior.

getCriteria

@Stability(value=Stable)
 @Nullable
default Object getCriteria()

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

getMetric

@Stability(value=Stable)
 @Nullable
default String getMetric()

What is measured by the behavior.

getMetricDimension

@Stability(value=Stable)
 @Nullable
default Object getMetricDimension()

The dimension of the metric.

getSuppressAlerts

@Stability(value=Stable)
 @Nullable
default Object getSuppressAlerts()

The alert status.

If you set the value to true , alerts will be suppressed.

builder

@Stability(value=Stable)
static CfnSecurityProfile.BehaviorProperty.Builder builder()

Returns:

a CfnSecurityProfile.BehaviorProperty.Builder of CfnSecurityProfile.BehaviorProperty