software.amazon.awscdk.services.iot

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(value=Stable)
public static final class CfnSecurityProfile.BehaviorCriteriaProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecurityProfile.BehaviorCriteriaProperty>

A builder for CfnSecurityProfile.BehaviorCriteriaProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnSecurityProfile.BehaviorCriteriaProperty	build() Builds the configured instance.
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	comparisonOperator(String comparisonOperator) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getComparisonOperator()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	consecutiveDatapointsToAlarm(Number consecutiveDatapointsToAlarm) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getConsecutiveDatapointsToAlarm()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	consecutiveDatapointsToClear(Number consecutiveDatapointsToClear) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getConsecutiveDatapointsToClear()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	durationSeconds(Number durationSeconds) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getDurationSeconds()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	mlDetectionConfig(CfnSecurityProfile.MachineLearningDetectionConfigProperty mlDetectionConfig) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	mlDetectionConfig(IResolvable mlDetectionConfig) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	statisticalThreshold(CfnSecurityProfile.StatisticalThresholdProperty statisticalThreshold) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	statisticalThreshold(IResolvable statisticalThreshold) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getStatisticalThreshold()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	value(CfnSecurityProfile.MetricValueProperty value) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getValue()
CfnSecurityProfile.BehaviorCriteriaProperty.Builder	value(IResolvable value) Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

comparisonOperator

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder comparisonOperator(String comparisonOperator)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getComparisonOperator()

Parameters:

comparisonOperator - The operator that relates the thing measured ( `metric` ) to the criteria (containing a `value` or `statisticalThreshold` ). Valid operators include:

• string-list : in-set and not-in-set
• number-list : in-set and not-in-set
• ip-address-list : in-cidr-set and not-in-cidr-set
• number : less-than , less-than-equals , greater-than , and greater-than-equals

Returns:

this

consecutiveDatapointsToAlarm

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder consecutiveDatapointsToAlarm(Number consecutiveDatapointsToAlarm)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getConsecutiveDatapointsToAlarm()

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(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder consecutiveDatapointsToClear(Number consecutiveDatapointsToClear)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getConsecutiveDatapointsToClear()

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(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder durationSeconds(Number durationSeconds)

Sets the value of CfnSecurityProfile.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 a statisticalThreshhold 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(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder mlDetectionConfig(CfnSecurityProfile.MachineLearningDetectionConfigProperty mlDetectionConfig)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()

Parameters:

mlDetectionConfig - The confidence level of the detection model.

Returns:

this

mlDetectionConfig

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder mlDetectionConfig(IResolvable mlDetectionConfig)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getMlDetectionConfig()

Parameters:

mlDetectionConfig - The confidence level of the detection model.

Returns:

this

statisticalThreshold

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder statisticalThreshold(CfnSecurityProfile.StatisticalThresholdProperty statisticalThreshold)

Sets the value of CfnSecurityProfile.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(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder statisticalThreshold(IResolvable statisticalThreshold)

Sets the value of CfnSecurityProfile.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(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder value(CfnSecurityProfile.MetricValueProperty value)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getValue()

Parameters:

value - The value to be compared with the `metric` .

Returns:

this

value

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty.Builder value(IResolvable value)

Sets the value of CfnSecurityProfile.BehaviorCriteriaProperty.getValue()

Parameters:

value - The value to be compared with the `metric` .

Returns:

this

build

@Stability(value=Stable)
public CfnSecurityProfile.BehaviorCriteriaProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSecurityProfile.BehaviorCriteriaProperty>

Returns:

a new instance of CfnSecurityProfile.BehaviorCriteriaProperty

Throws:

NullPointerException - if any required attribute was not provided