Class CfnSecurityProfile.BehaviorCriteriaProperty.Builder
java.lang.Object
software.amazon.awscdk.services.iot.CfnSecurityProfile.BehaviorCriteriaProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSecurityProfile.BehaviorCriteriaProperty>
- Enclosing interface:
CfnSecurityProfile.BehaviorCriteriaProperty
@Stability(Stable)
public static final class CfnSecurityProfile.BehaviorCriteriaProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecurityProfile.BehaviorCriteriaProperty>
A builder for
CfnSecurityProfile.BehaviorCriteriaProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.comparisonOperator
(String comparisonOperator) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getComparisonOperator()
consecutiveDatapointsToAlarm
(Number consecutiveDatapointsToAlarm) consecutiveDatapointsToClear
(Number consecutiveDatapointsToClear) durationSeconds
(Number durationSeconds) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getDurationSeconds()
mlDetectionConfig
(IResolvable mlDetectionConfig) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
mlDetectionConfig
(CfnSecurityProfile.MachineLearningDetectionConfigProperty mlDetectionConfig) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
statisticalThreshold
(IResolvable statisticalThreshold) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
statisticalThreshold
(CfnSecurityProfile.StatisticalThresholdProperty statisticalThreshold) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
value
(IResolvable value) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getValue()
Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getValue()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
comparisonOperator
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder comparisonOperator(String comparisonOperator) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getComparisonOperator()
- Parameters:
comparisonOperator
- The operator that relates the thing measured (metric
) to the criteria (containing avalue
orstatisticalThreshold
). Valid operators include:string-list
:in-set
andnot-in-set
number-list
:in-set
andnot-in-set
ip-address-list
:in-cidr-set
andnot-in-cidr-set
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
- Returns:
this
-
consecutiveDatapointsToAlarm
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder consecutiveDatapointsToAlarm(Number consecutiveDatapointsToAlarm) - Parameters:
consecutiveDatapointsToAlarm
- If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.- Returns:
this
-
consecutiveDatapointsToClear
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder consecutiveDatapointsToClear(Number consecutiveDatapointsToClear) - Parameters:
consecutiveDatapointsToClear
- If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.- Returns:
this
-
durationSeconds
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder durationSeconds(Number durationSeconds) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getDurationSeconds()
- Parameters:
durationSeconds
- Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example,NUM_MESSAGES_SENT
). For astatisticalThreshhold
metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.- Returns:
this
-
mlDetectionConfig
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder mlDetectionConfig(IResolvable mlDetectionConfig) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
- Parameters:
mlDetectionConfig
- The confidence level of the detection model.- Returns:
this
-
mlDetectionConfig
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder mlDetectionConfig(CfnSecurityProfile.MachineLearningDetectionConfigProperty mlDetectionConfig) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
- Parameters:
mlDetectionConfig
- The confidence level of the detection model.- Returns:
this
-
statisticalThreshold
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder statisticalThreshold(IResolvable statisticalThreshold) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
- Parameters:
statisticalThreshold
- A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.- Returns:
this
-
statisticalThreshold
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder statisticalThreshold(CfnSecurityProfile.StatisticalThresholdProperty statisticalThreshold) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
- Parameters:
statisticalThreshold
- A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.- Returns:
this
-
value
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder value(IResolvable value) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getValue()
- Parameters:
value
- The value to be compared with themetric
.- Returns:
this
-
value
@Stability(Stable) public CfnSecurityProfile.BehaviorCriteriaProperty.Builder value(CfnSecurityProfile.MetricValueProperty value) Sets the value ofCfnSecurityProfile.BehaviorCriteriaProperty.getValue()
- Parameters:
value
- The value to be compared with themetric
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnSecurityProfile.BehaviorCriteriaProperty>
- Returns:
- a new instance of
CfnSecurityProfile.BehaviorCriteriaProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-