Module Values.AutomationRulesConfigSource

Defines the configuration of an automation rule.

Sourcetype nonrec t = {
  1. ruleArn : NonEmptyString.t option;
    (*

    The Amazon Resource Name (ARN) of a rule.

    *)
  2. ruleStatus : RuleStatus.t option;
    (*

    Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub CSPM starts applying the rule to findings and finding updates after the rule is created.

    *)
  3. ruleOrder : RuleOrderValue.t option;
    (*

    An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first.

    *)
  4. ruleName : NonEmptyString.t option;
    (*

    The name of the rule.

    *)
  5. description : NonEmptyString.t option;
    (*

    A description of the rule.

    *)
  6. isTerminal : Boolean.t option;
    (*

    Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub CSPM applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.

    *)
  7. criteria : AutomationRulesFindingFilters.t option;
    (*

    A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that Security Hub CSPM uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub CSPM applies the rule action to the finding.

    *)
  8. actions : ActionList.t option;
    (*

    One or more actions to update finding fields if a finding matches the defined criteria of the rule.

    *)
  9. createdAt : Timestamp.t option;
    (*

    A timestamp that indicates when the rule was created. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

    *)
  10. updatedAt : Timestamp.t option;
    (*

    A timestamp that indicates when the rule was most recently updated. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

    *)
  11. createdBy : NonEmptyString.t option;
    (*

    The principal that created a rule.

    *)
}
Sourceval make : ?ruleArn:??? -> ?ruleStatus:??? -> ?ruleOrder:??? -> ?ruleName:??? -> ?description:??? -> ?isTerminal:??? -> ?criteria:??? -> ?actions:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?createdBy:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of RuleOrderValue.t | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `Integer of RatioScale.t | `List of [> `String of NonEmptyString.t | `Structure of (string * [> `String of NonEmptyString.t ]) list ] list | `Map of ([> `String of NonEmptyString.t ] * [> `String of NonEmptyString.t ]) list | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of RatioScale.t | `String of NonEmptyString.t ]) list ]) list ]) list ] list | `String of NonEmptyString.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Double of Double.t | `Enum of string | `String of NonEmptyString.t | `Structure of (string * [> `Enum of string | `Integer of Integer.t ]) list ]) list ] list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t