RuleDeploymentArgs class - chronicle library

Constructors

RuleDeploymentArgs({Input<bool?>? alerting, Input<bool?>? archived, Input<bool?>? enabled, required Input<String> instance, required Input<String> location, Input<String?>? project, required Input<String> rule, Input<String?>? runFrequency, Input<RuleDeploymentScheduleCustomizations?>? scheduleCustomizations}): Creates a new RuleDeploymentArgs. alerting Whether detections resulting from this deployment should be considered archived The archive state of the rule deployment. enabled Whether the rule is currently deployed continuously against incoming data. instance The unique identifier for the Chronicle instance, which is the same as the customer ID. location The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". project The ID of the project in which the resource belongs. rule The Rule ID of the rule. runFrequency The run frequency of the rule deployment. scheduleCustomizations The schedule customizations of the rule deployment. Only valid for
const
RuleDeploymentArgs.fromMap(Map<String, dynamic> map): factory

Properties

alerting → Input<bool?>?: Whether detections resulting from this deployment should be considered alerts.
final
archived → Input<bool?>?: The archive state of the rule deployment. Cannot be set to true unless enabled is set to false i.e. archiving requires a two-step process: first, disable the rule by setting 'enabled' to false, then set 'archive' to true. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and runFrequency cannot be updated.
final
enabled → Input<bool?>?: Whether the rule is currently deployed continuously against incoming data.
final
hashCode → int: The hash code for this object.
no setterinherited
instance → Input<String>: The unique identifier for the Chronicle instance, which is the same as the customer ID.
final
location → Input<String>: The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
final
project → Input<String?>?: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
rule → Input<String>: The Rule ID of the rule.
final
runFrequency → Input<String?>?: The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY LIVE_CUSTOMIZABLE HOURLY_CUSTOMIZABLE Note: Certain legacy run frequencies are deprecated. For multi-event rules, use LIVE_CUSTOMIZABLE or HOURLY_CUSTOMIZABLE (for match windows <=2d), or DAILY (for match windows >2d). Legacy values LIVE and HOURLY are mapped to their customizable counterparts on the backend. DAILY for <=2d match window multi-event rules will be happed to HOURLY_CUSTOMIZABLE. For single-event rules, HOURLY and DAILY are deprecated and mapped to LIVE. If you continue to use deprecated values in your Terraform configuration, Terraform will silently suppress the diff and ignore the changes to prevent infinite update loops.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scheduleCustomizations → Input<RuleDeploymentScheduleCustomizations?>?: The schedule customizations of the rule deployment. Only valid for customizable run frequencies. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited