Interface CfnSecurityProfile.BehaviorCriteriaProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnSecurityProfile.BehaviorCriteriaProperty extends
The criteria by which the behavior is determined to be normal.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BehaviorCriteriaProperty behaviorCriteriaProperty = BehaviorCriteriaProperty.builder()
  • Method Details

    • getComparisonOperator

      @Stability(Stable) @Nullable default String getComparisonOperator()
      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
    • getConsecutiveDatapointsToAlarm

      @Stability(Stable) @Nullable default Number getConsecutiveDatapointsToAlarm()
      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.

    • getConsecutiveDatapointsToClear

      @Stability(Stable) @Nullable default Number getConsecutiveDatapointsToClear()
      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.

    • getDurationSeconds

      @Stability(Stable) @Nullable default Number getDurationSeconds()
      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.

    • getMlDetectionConfig

      @Stability(Stable) @Nullable default Object getMlDetectionConfig()
      The confidence level of the detection model.
    • getStatisticalThreshold

      @Stability(Stable) @Nullable default Object getStatisticalThreshold()
      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.
    • getValue

      @Stability(Stable) @Nullable default Object getValue()
      The value to be compared with the metric .
    • builder

      @Stability(Stable) static CfnSecurityProfile.BehaviorCriteriaProperty.Builder builder()
      a CfnSecurityProfile.BehaviorCriteriaProperty.Builder of CfnSecurityProfile.BehaviorCriteriaProperty