Package 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(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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Object	getExportMetric()	Value indicates exporting metrics related to the behavior when it is true.
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 Details

getName

@Stability(Stable)
@NotNull
String getName()

The name you've given to the behavior.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-name

getCriteria

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

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

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.

Returns union: either IResolvable or CfnSecurityProfile.BehaviorCriteriaProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-criteria

getExportMetric

@Stability(Stable)
@Nullable
default Object getExportMetric()

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-exportmetric

getMetric

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

What is measured by the behavior.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metric

getMetricDimension

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

The dimension of the metric.

Returns union: either IResolvable or CfnSecurityProfile.MetricDimensionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metricdimension

getSuppressAlerts

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

The alert status.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-suppressalerts

builder

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

Returns:

a CfnSecurityProfile.BehaviorProperty.Builder of CfnSecurityProfile.BehaviorProperty