Skip to content

Commit ea2c798

Browse files
modular-magicianmodular-magician
authoredJan 11, 2025··
Add google_chronicle_rule_deployment resource to chronicle (#12729) (#9043)
[upstream:7d808d92fa8b8aab4dbdf706b1f97caf6edae3c3] Signed-off-by: Modular Magician <[email protected]>
·
v6.28.0v6.17.0
1 parent 7317470 commit ea2c798

7 files changed

+875
-2
lines changed
 

‎.changelog/12729.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:new-resource
2+
`google_chronicle_rule_deployment`
3+
```

‎google-beta/provider/provider_mmv1_resources.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -516,9 +516,9 @@ var handwrittenIAMDatasources = map[string]*schema.Resource{
516516
}
517517

518518
// Resources
519-
// Generated resources: 583
519+
// Generated resources: 584
520520
// Generated IAM resources: 294
521-
// Total generated resources: 877
521+
// Total generated resources: 878
522522
var generatedResources = map[string]*schema.Resource{
523523
"google_folder_access_approval_settings": accessapproval.ResourceAccessApprovalFolderSettings(),
524524
"google_organization_access_approval_settings": accessapproval.ResourceAccessApprovalOrganizationSettings(),
@@ -655,6 +655,7 @@ var generatedResources = map[string]*schema.Resource{
655655
"google_chronicle_data_access_label": chronicle.ResourceChronicleDataAccessLabel(),
656656
"google_chronicle_data_access_scope": chronicle.ResourceChronicleDataAccessScope(),
657657
"google_chronicle_rule": chronicle.ResourceChronicleRule(),
658+
"google_chronicle_rule_deployment": chronicle.ResourceChronicleRuleDeployment(),
658659
"google_chronicle_watchlist": chronicle.ResourceChronicleWatchlist(),
659660
"google_cloud_asset_folder_feed": cloudasset.ResourceCloudAssetFolderFeed(),
660661
"google_cloud_asset_organization_feed": cloudasset.ResourceCloudAssetOrganizationFeed(),

‎google-beta/services/chronicle/resource_chronicle_rule_deployment.go

+508
Large diffs are not rendered by default.

‎google-beta/services/chronicle/resource_chronicle_rule_deployment_generated_meta.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
resource: 'google_chronicle_rule_deployment'
2+
generation_type: 'mmv1'
3+
api_service_name: 'chronicle.googleapis.com'
4+
api_version: 'v1beta'
5+
api_resource_type_kind: 'RuleDeployment'

‎google-beta/services/chronicle/resource_chronicle_rule_deployment_generated_test.go

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
// ----------------------------------------------------------------------------
5+
//
6+
// *** AUTO GENERATED CODE *** Type: MMv1 ***
7+
//
8+
// ----------------------------------------------------------------------------
9+
//
10+
// This file is automatically generated by Magic Modules and manual
11+
// changes will be clobbered when the file is regenerated.
12+
//
13+
// Please read more about how to change this file in
14+
// .github/CONTRIBUTING.md.
15+
//
16+
// ----------------------------------------------------------------------------
17+
18+
package chronicle_test
19+
20+
import (
21+
"testing"
22+
23+
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
24+
25+
"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
26+
"github.com/hashicorp/terraform-provider-google-beta/google-beta/envvar"
27+
)
28+
29+
func TestAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample(t *testing.T) {
30+
t.Parallel()
31+
32+
context := map[string]interface{}{
33+
"chronicle_id": envvar.GetTestChronicleInstanceIdFromEnv(t),
34+
"random_suffix": acctest.RandString(t, 10),
35+
}
36+
37+
acctest.VcrTest(t, resource.TestCase{
38+
PreCheck: func() { acctest.AccTestPreCheck(t) },
39+
ProtoV5ProviderFactories: acctest.ProtoV5ProviderBetaFactories(t),
40+
Steps: []resource.TestStep{
41+
{
42+
Config: testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample(context),
43+
},
44+
{
45+
ResourceName: "google_chronicle_rule_deployment.example",
46+
ImportState: true,
47+
ImportStateVerify: true,
48+
ImportStateVerifyIgnore: []string{"instance", "location", "rule"},
49+
},
50+
},
51+
})
52+
}
53+
54+
func testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample(context map[string]interface{}) string {
55+
return acctest.Nprintf(`
56+
resource "google_chronicle_rule" "my-rule" {
57+
provider = "google-beta"
58+
location = "us"
59+
instance = "%{chronicle_id}"
60+
text = <<-EOT
61+
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
62+
EOT
63+
}
64+
65+
resource "google_chronicle_rule_deployment" "example" {
66+
provider = "google-beta"
67+
location = "us"
68+
instance = "%{chronicle_id}"
69+
rule = element(split("/", resource.google_chronicle_rule.my-rule.name), length(split("/", resource.google_chronicle_rule.my-rule.name)) - 1)
70+
enabled = true
71+
alerting = true
72+
archived = false
73+
run_frequency = "DAILY"
74+
}
75+
`, context)
76+
}

‎google-beta/services/chronicle/resource_chronicle_rule_deployment_test.go

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
package chronicle_test
4+
5+
import (
6+
"testing"
7+
8+
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
9+
10+
"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
11+
"github.com/hashicorp/terraform-provider-google-beta/google-beta/envvar"
12+
)
13+
14+
func TestAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample_update(t *testing.T) {
15+
t.Parallel()
16+
17+
context := map[string]interface{}{
18+
"chronicle_id": envvar.GetTestChronicleInstanceIdFromEnv(t),
19+
"random_suffix": acctest.RandString(t, 10),
20+
}
21+
22+
acctest.VcrTest(t, resource.TestCase{
23+
PreCheck: func() { acctest.AccTestPreCheck(t) },
24+
ProtoV5ProviderFactories: acctest.ProtoV5ProviderBetaFactories(t),
25+
Steps: []resource.TestStep{
26+
{
27+
Config: testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample_basic(context),
28+
},
29+
{
30+
ResourceName: "google_chronicle_rule_deployment.example",
31+
ImportState: true,
32+
ImportStateVerify: true,
33+
ImportStateVerifyIgnore: []string{"instance", "location", "rule"},
34+
},
35+
{
36+
Config: testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample_update(context),
37+
},
38+
{
39+
ResourceName: "google_chronicle_rule_deployment.example",
40+
ImportState: true,
41+
ImportStateVerify: true,
42+
ImportStateVerifyIgnore: []string{"instance", "location", "rule"},
43+
},
44+
},
45+
})
46+
}
47+
48+
func testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample_basic(context map[string]interface{}) string {
49+
return acctest.Nprintf(`
50+
resource "google_chronicle_rule" "my-rule" {
51+
provider = "google-beta"
52+
location = "us"
53+
instance = "%{chronicle_id}"
54+
text = <<-EOT
55+
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
56+
EOT
57+
}
58+
59+
resource "google_chronicle_rule_deployment" "example" {
60+
provider = "google-beta"
61+
location = "us"
62+
instance = "%{chronicle_id}"
63+
rule = element(split("/", resource.google_chronicle_rule.my-rule.name), length(split("/", resource.google_chronicle_rule.my-rule.name)) - 1)
64+
enabled = true
65+
alerting = true
66+
archived = false
67+
run_frequency = "DAILY"
68+
}
69+
`, context)
70+
}
71+
72+
func testAccChronicleRuleDeployment_chronicleRuledeploymentBasicExample_update(context map[string]interface{}) string {
73+
return acctest.Nprintf(`
74+
resource "google_chronicle_rule" "my-rule" {
75+
provider = "google-beta"
76+
location = "us"
77+
instance = "%{chronicle_id}"
78+
text = <<-EOT
79+
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
80+
EOT
81+
}
82+
83+
resource "google_chronicle_rule_deployment" "example" {
84+
provider = "google-beta"
85+
location = "us"
86+
instance = "%{chronicle_id}"
87+
rule = element(split("/", resource.google_chronicle_rule.my-rule.name), length(split("/", resource.google_chronicle_rule.my-rule.name)) - 1)
88+
enabled = false
89+
alerting = false
90+
archived = false
91+
run_frequency = "HOURLY"
92+
}
93+
`, context)
94+
}

‎website/docs/r/chronicle_rule_deployment.html.markdown

+186
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
# ----------------------------------------------------------------------------
3+
#
4+
# *** AUTO GENERATED CODE *** Type: MMv1 ***
5+
#
6+
# ----------------------------------------------------------------------------
7+
#
8+
# This file is automatically generated by Magic Modules and manual
9+
# changes will be clobbered when the file is regenerated.
10+
#
11+
# Please read more about how to change this file in
12+
# .github/CONTRIBUTING.md.
13+
#
14+
# ----------------------------------------------------------------------------
15+
subcategory: "Chronicle"
16+
description: |-
17+
The RuleDeployment resource represents the deployment state of a Rule.
18+
---
19+
20+
# google_chronicle_rule_deployment
21+
22+
The RuleDeployment resource represents the deployment state of a Rule.
23+
24+
~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
25+
See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources.
26+
27+
To get more information about RuleDeployment, see:
28+
29+
* [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1alpha/RuleDeployment)
30+
* How-to Guides
31+
* [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
32+
33+
## Example Usage - Chronicle Ruledeployment Basic
34+
35+
36+
```hcl
37+
resource "google_chronicle_rule" "my-rule" {
38+
provider = "google-beta"
39+
location = "us"
40+
instance = "00000000-0000-0000-0000-000000000000"
41+
text = <<-EOT
42+
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
43+
EOT
44+
}
45+
46+
resource "google_chronicle_rule_deployment" "example" {
47+
provider = "google-beta"
48+
location = "us"
49+
instance = "00000000-0000-0000-0000-000000000000"
50+
rule = element(split("/", resource.google_chronicle_rule.my-rule.name), length(split("/", resource.google_chronicle_rule.my-rule.name)) - 1)
51+
enabled = true
52+
alerting = true
53+
archived = false
54+
run_frequency = "DAILY"
55+
}
56+
```
57+
58+
## Argument Reference
59+
60+
The following arguments are supported:
61+
62+
63+
* `location` -
64+
(Required)
65+
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
66+
67+
* `instance` -
68+
(Required)
69+
The unique identifier for the Chronicle instance, which is the same as the customer ID.
70+
71+
* `rule` -
72+
(Required)
73+
The Rule ID of the rule.
74+
75+
76+
- - -
77+
78+
79+
* `enabled` -
80+
(Optional)
81+
Whether the rule is currently deployed continuously against incoming data.
82+
83+
* `alerting` -
84+
(Optional)
85+
Whether detections resulting from this deployment should be considered
86+
alerts.
87+
88+
* `archived` -
89+
(Optional)
90+
The archive state of the rule deployment.
91+
Cannot be set to true unless enabled is set to false.
92+
If set to true, alerting will automatically be set to false.
93+
If currently set to true, enabled, alerting, and run_frequency cannot be
94+
updated.
95+
96+
* `run_frequency` -
97+
(Optional)
98+
The run frequency of the rule deployment.
99+
Possible values:
100+
LIVE
101+
HOURLY
102+
DAILY
103+
104+
* `project` - (Optional) The ID of the project in which the resource belongs.
105+
If it is not provided, the provider project is used.
106+
107+
108+
## Attributes Reference
109+
110+
In addition to the arguments listed above, the following computed attributes are exported:
111+
112+
* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment`
113+
114+
* `name` -
115+
The resource name of the rule deployment.
116+
Note that RuleDeployment is a child of the overall Rule, not any individual
117+
revision, so the resource ID segment for the Rule resource must not
118+
reference a specific revision.
119+
Format:
120+
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment
121+
122+
* `archive_time` -
123+
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.
124+
125+
* `execution_state` -
126+
The execution state of the rule deployment.
127+
Possible values:
128+
DEFAULT
129+
LIMITED
130+
PAUSED
131+
132+
* `producer_rules` -
133+
Output only. The names of the associated/chained producer rules. Rules are considered
134+
producers for this rule if this rule explicitly filters on their ruleid.
135+
Format:
136+
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
137+
138+
* `consumer_rules` -
139+
Output only. The names of the associated/chained consumer rules. Rules are considered
140+
consumers of this rule if their rule text explicitly filters on this rule's ruleid.
141+
Format:
142+
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
143+
144+
* `last_alert_status_change_time` -
145+
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.
146+
147+
148+
## Timeouts
149+
150+
This resource provides the following
151+
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
152+
153+
- `create` - Default is 20 minutes.
154+
- `update` - Default is 20 minutes.
155+
- `delete` - Default is 20 minutes.
156+
157+
## Import
158+
159+
160+
RuleDeployment can be imported using any of these accepted formats:
161+
162+
* `projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment`
163+
* `{{project}}/{{location}}/{{instance}}/{{rule}}`
164+
* `{{location}}/{{instance}}/{{rule}}`
165+
166+
167+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RuleDeployment using one of the formats above. For example:
168+
169+
```tf
170+
import {
171+
id = "projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment"
172+
to = google_chronicle_rule_deployment.default
173+
}
174+
```
175+
176+
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), RuleDeployment can be imported using one of the formats above. For example:
177+
178+
```
179+
$ terraform import google_chronicle_rule_deployment.default projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment
180+
$ terraform import google_chronicle_rule_deployment.default {{project}}/{{location}}/{{instance}}/{{rule}}
181+
$ terraform import google_chronicle_rule_deployment.default {{location}}/{{instance}}/{{rule}}
182+
```
183+
184+
## User Project Overrides
185+
186+
This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).

0 commit comments

Comments
 (0)
Please sign in to comment.