Module Values.AutomationRulesMetadataSource

Metadata for automation rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.

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

    The Amazon Resource Name (ARN) for the 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. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .

    *)
  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. 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.

    *)
  8. 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.

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

    The principal that created a rule.

    *)
}
Sourceval make : ?ruleArn:??? -> ?ruleStatus:??? -> ?ruleOrder:??? -> ?ruleName:??? -> ?description:??? -> ?isTerminal:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?createdBy:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of RuleOrderValue.t | `String of NonEmptyString.t | `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