RuleDeployment class
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
Chronicle Ruledeployment Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";
const my_rule = new gcp.chronicle.Rule("my-rule", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
text: "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n",
});
const example = new gcp.chronicle.RuleDeployment("example", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
rule: pulumi.all([std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}), std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}).then(invoke => invoke.result).length]).apply(([invoke, length]) => invoke.result[length - 1]).apply(x =>String(x)),
enabled: true,
alerting: true,
archived: false,
runFrequency: "LIVE",
});
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std
my_rule = gcp.chronicle.Rule("my-rule",
location="us",
instance="00000000-0000-0000-0000-000000000000",
text="rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n")
example = gcp.chronicle.RuleDeployment("example",
location="us",
instance="00000000-0000-0000-0000-000000000000",
rule=len(std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result).apply(lambda length: std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result[int(length - 1)]).apply(lambda x: str(x)),
enabled=True,
alerting=True,
archived=False,
run_frequency="LIVE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var my_rule = new Gcp.Chronicle.Rule("my-rule", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Text = @"rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
",
});
var example = new Gcp.Chronicle.RuleDeployment("example", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Rule = Output.Tuple(Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}), Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}).Apply(invoke => invoke.Result).Length()).Apply(values =>
{
var invoke = values.Item1;
var length = values.Item2;
return invoke.Result[(int)(length - 1)];
}).Apply(x => x.ToString(System.Globalization.CultureInfo.InvariantCulture)),
Enabled = true,
Alerting = true,
Archived = false,
RunFrequency = "LIVE",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := chronicle.NewRule(ctx, "my-rule", &chronicle.RuleArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Text: pulumi.String("rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"),
})
if err != nil {
return err
}
invokeSplit, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
invokeSplit1, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
_, err = chronicle.NewRuleDeployment(ctx, "example", &chronicle.RuleDeploymentArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Rule: pulumi.String(len(invokeSplit.Result).ApplyT(func(length int) (pulumi.Any, error) {
%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference)).(pulumi.AnyOutput)),
Enabled: pulumi.Bool(true),
Alerting: pulumi.Bool(true),
Archived: pulumi.Bool(false),
RunFrequency: pulumi.String("LIVE"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
std = {
source = "pulumi/std"
}
}
}
resource "gcp_chronicle_rule" "my-rule" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
text = "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"
}
resource "gcp_chronicle_ruledeployment" "example" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
rule = element(split("/", googleChronicleRule.my-rule.name), length(split("/", googleChronicleRule.my-rule.name)) - 1)
enabled = true
alerting = true
archived = false
run_frequency = "LIVE"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Rule;
import com.pulumi.gcp.chronicle.RuleArgs;
import com.pulumi.gcp.chronicle.RuleDeployment;
import com.pulumi.gcp.chronicle.RuleDeploymentArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.SplitArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var my_rule = new Rule("my-rule", RuleArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.text("""
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
""")
.build());
var example = new RuleDeployment("example", RuleDeploymentArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.rule(((String) StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result().size().applyValue(_length -> StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result()[_length - 1])))
.enabled(true)
.alerting(true)
.archived(false)
.runFrequency("LIVE")
.build());
}
}
Chronicle Ruledeployment Disabled
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";
const my_rule = new gcp.chronicle.Rule("my-rule", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
text: "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n",
});
const example = new gcp.chronicle.RuleDeployment("example", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
rule: pulumi.all([std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}), std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}).then(invoke => invoke.result).length]).apply(([invoke, length]) => invoke.result[length - 1]).apply(x =>String(x)),
enabled: false,
runFrequency: "LIVE",
});
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std
my_rule = gcp.chronicle.Rule("my-rule",
location="us",
instance="00000000-0000-0000-0000-000000000000",
text="rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n")
example = gcp.chronicle.RuleDeployment("example",
location="us",
instance="00000000-0000-0000-0000-000000000000",
rule=len(std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result).apply(lambda length: std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result[int(length - 1)]).apply(lambda x: str(x)),
enabled=False,
run_frequency="LIVE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var my_rule = new Gcp.Chronicle.Rule("my-rule", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Text = @"rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
",
});
var example = new Gcp.Chronicle.RuleDeployment("example", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Rule = Output.Tuple(Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}), Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}).Apply(invoke => invoke.Result).Length()).Apply(values =>
{
var invoke = values.Item1;
var length = values.Item2;
return invoke.Result[(int)(length - 1)];
}).Apply(x => x.ToString(System.Globalization.CultureInfo.InvariantCulture)),
Enabled = false,
RunFrequency = "LIVE",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := chronicle.NewRule(ctx, "my-rule", &chronicle.RuleArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Text: pulumi.String("rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"),
})
if err != nil {
return err
}
invokeSplit, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
invokeSplit1, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
_, err = chronicle.NewRuleDeployment(ctx, "example", &chronicle.RuleDeploymentArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Rule: pulumi.String(len(invokeSplit.Result).ApplyT(func(length int) (pulumi.Any, error) {
%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference)).(pulumi.AnyOutput)),
Enabled: pulumi.Bool(false),
RunFrequency: pulumi.String("LIVE"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
std = {
source = "pulumi/std"
}
}
}
resource "gcp_chronicle_rule" "my-rule" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
text = "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"
}
resource "gcp_chronicle_ruledeployment" "example" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
rule = element(split("/", googleChronicleRule.my-rule.name), length(split("/", googleChronicleRule.my-rule.name)) - 1)
enabled = false
run_frequency = "LIVE"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Rule;
import com.pulumi.gcp.chronicle.RuleArgs;
import com.pulumi.gcp.chronicle.RuleDeployment;
import com.pulumi.gcp.chronicle.RuleDeploymentArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.SplitArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var my_rule = new Rule("my-rule", RuleArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.text("""
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
""")
.build());
var example = new RuleDeployment("example", RuleDeploymentArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.rule(((String) StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result().size().applyValue(_length -> StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result()[_length - 1])))
.enabled(false)
.runFrequency("LIVE")
.build());
}
}
Chronicle Ruledeployment Run Frequency Missing
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";
const my_rule = new gcp.chronicle.Rule("my-rule", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
text: "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n",
});
const example = new gcp.chronicle.RuleDeployment("example", {
location: "us",
instance: "00000000-0000-0000-0000-000000000000",
rule: pulumi.all([std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}), std.split({
separator: "/",
text: googleChronicleRule["my-rule"].name,
}).then(invoke => invoke.result).length]).apply(([invoke, length]) => invoke.result[length - 1]).apply(x =>String(x)),
enabled: true,
alerting: true,
archived: false,
});
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std
my_rule = gcp.chronicle.Rule("my-rule",
location="us",
instance="00000000-0000-0000-0000-000000000000",
text="rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n")
example = gcp.chronicle.RuleDeployment("example",
location="us",
instance="00000000-0000-0000-0000-000000000000",
rule=len(std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result).apply(lambda length: std.split(separator="/",
text=google_chronicle_rule["my-rule"]["name"]).result[int(length - 1)]).apply(lambda x: str(x)),
enabled=True,
alerting=True,
archived=False)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var my_rule = new Gcp.Chronicle.Rule("my-rule", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Text = @"rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
",
});
var example = new Gcp.Chronicle.RuleDeployment("example", new()
{
Location = "us",
Instance = "00000000-0000-0000-0000-000000000000",
Rule = Output.Tuple(Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}), Std.Split.Invoke(new()
{
Separator = "/",
Text = googleChronicleRule.My_rule.Name,
}).Apply(invoke => invoke.Result).Length()).Apply(values =>
{
var invoke = values.Item1;
var length = values.Item2;
return invoke.Result[(int)(length - 1)];
}).Apply(x => x.ToString(System.Globalization.CultureInfo.InvariantCulture)),
Enabled = true,
Alerting = true,
Archived = false,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := chronicle.NewRule(ctx, "my-rule", &chronicle.RuleArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Text: pulumi.String("rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"),
})
if err != nil {
return err
}
invokeSplit, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
invokeSplit1, err := std.Split(ctx, &std.SplitArgs{
Separator: "/",
Text: googleChronicleRule.MyRule.Name,
}, nil)
if err != nil {
return err
}
_, err = chronicle.NewRuleDeployment(ctx, "example", &chronicle.RuleDeploymentArgs{
Location: pulumi.String("us"),
Instance: pulumi.String("00000000-0000-0000-0000-000000000000"),
Rule: pulumi.String(len(invokeSplit.Result).ApplyT(func(length int) (pulumi.Any, error) {
%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference)).(pulumi.AnyOutput)),
Enabled: pulumi.Bool(true),
Alerting: pulumi.Bool(true),
Archived: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
std = {
source = "pulumi/std"
}
}
}
resource "gcp_chronicle_rule" "my-rule" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
text = "rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }\n"
}
resource "gcp_chronicle_ruledeployment" "example" {
location = "us"
instance = "00000000-0000-0000-0000-000000000000"
rule = element(split("/", googleChronicleRule.my-rule.name), length(split("/", googleChronicleRule.my-rule.name)) - 1)
enabled = true
alerting = true
archived = false
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Rule;
import com.pulumi.gcp.chronicle.RuleArgs;
import com.pulumi.gcp.chronicle.RuleDeployment;
import com.pulumi.gcp.chronicle.RuleDeploymentArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.SplitArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var my_rule = new Rule("my-rule", RuleArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.text("""
rule test_rule { meta: events: $userid = $e.principal.user.userid match: $userid over 10m condition: $e }
""")
.build());
var example = new RuleDeployment("example", RuleDeploymentArgs.builder()
.location("us")
.instance("00000000-0000-0000-0000-000000000000")
.rule(((String) StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result().size().applyValue(_length -> StdFunctions.split(SplitArgs.builder()
.separator("/")
.text(googleChronicleRule.get("my-rule").get("name"))
.build()).result()[_length - 1])))
.enabled(true)
.alerting(true)
.archived(false)
.build());
}
}
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}}
Constructors
- RuleDeployment(String name, {RuleDeploymentArgs? args, CustomResourceOptions? options})
-
Creates a new RuleDeployment.
nameThe Pulumi resource name.argsArguments used to configure this RuleDeployment. The set of arguments for RuleDeployment.optionsResource options controlling this resource's behavior. - RuleDeployment.reference(String urn)
- Creates a typed reference to an existing RuleDeployment resource.
Properties
-
alerting
↔ Output<
bool?> -
Whether detections resulting from this deployment should be considered
alerts.
latefinal
-
archived
↔ Output<
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.
latefinal
-
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.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
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}
latefinal
-
enabled
↔ Output<
bool?> -
Whether the rule is currently deployed continuously against incoming data.
latefinal
-
executionState
↔ Output<
String> -
The execution state of the rule deployment.
Possible values:
DEFAULT
LIMITED
PAUSED
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instance
↔ Output<
String> -
The unique identifier for the Chronicle instance, which is the same as the customer ID.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
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.
latefinal
-
location
↔ Output<
String> -
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
latefinal
-
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
latefinal
-
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}
latefinal
-
project
↔ Output<
String> -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rule
↔ Output<
String> -
The Rule ID of the rule.
latefinal
-
runFrequency
↔ Output<
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.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scheduleCustomizations
↔ Output<
RuleDeploymentScheduleCustomizations?> -
The schedule customizations of the rule deployment. Only valid for
customizable run frequencies.
Structure is documented below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RuleDeploymentState? state, CustomResourceOptions? options}) → RuleDeployment -
Gets an existing RuleDeployment resource's state with the given
nameandid.