pulumi-gcp-kotlin/com.pulumi.gcp.chronicle.kotlin/RuleDeployment

RuleDeployment

class RuleDeployment : KotlinCustomResource

The RuleDeployment resource represents the deployment state of a Rule. To get more information about RuleDeployment, see:

API documentation
How-to Guides

Google SecOps Guides

Example Usage

Import

RuleDeployment can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment
{{project}}/{{location}}/{{instance}}/{{rule}}
{{location}}/{{instance}}/{{rule}} When using the pulumi import command, RuleDeployment can be imported using one of the formats above. For example:

$ pulumi import gcp:chronicle/ruleDeployment:RuleDeployment default projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment

$ pulumi import gcp:chronicle/ruleDeployment:RuleDeployment default {{project}}/{{location}}/{{instance}}/{{rule}}

$ pulumi import gcp:chronicle/ruleDeployment:RuleDeployment default {{location}}/{{instance}}/{{rule}}

Properties

alerting

val alerting: Output<Boolean>?

Whether detections resulting from this deployment should be considered alerts.

archived

val archived: Output<Boolean>?

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 run_frequency cannot be updated.

archiveTime

val archiveTime: Output<String>

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.

consumerRules

val consumerRules: Output<List<String>>

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

enabled

val enabled: Output<Boolean>?

Whether the rule is currently deployed continuously against incoming data.

executionState

val executionState: Output<String>

The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED

val id: Output<String>

instance

val instance: Output<String>

The unique identifier for the Chronicle instance, which is the same as the customer ID.

lastAlertStatusChangeTime

val lastAlertStatusChangeTime: Output<String>

Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state.E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.

location

val location: Output<String>

The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".

name

val name: Output<String>

The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

producerRules

val producerRules: Output<List<String>>

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

rule

val rule: Output<String>

The Rule ID of the rule.

runFrequency

val runFrequency: Output<String>?

The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY

urn

val urn: Output<String>