Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. chronicle
  5. RuleDeployment
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.chronicle.RuleDeployment

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

The RuleDeployment resource represents the deployment state of a Rule.

To get more information about RuleDeployment, see:

Example Usage

Create RuleDeployment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RuleDeployment(name: string, args: RuleDeploymentArgs, opts?: CustomResourceOptions);
@overload
def RuleDeployment(resource_name: str,
                   args: RuleDeploymentArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def RuleDeployment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance: Optional[str] = None,
                   location: Optional[str] = None,
                   rule: Optional[str] = None,
                   alerting: Optional[bool] = None,
                   archived: Optional[bool] = None,
                   enabled: Optional[bool] = None,
                   project: Optional[str] = None,
                   run_frequency: Optional[str] = None)
func NewRuleDeployment(ctx *Context, name string, args RuleDeploymentArgs, opts ...ResourceOption) (*RuleDeployment, error)
public RuleDeployment(string name, RuleDeploymentArgs args, CustomResourceOptions? opts = null)
public RuleDeployment(String name, RuleDeploymentArgs args)
public RuleDeployment(String name, RuleDeploymentArgs args, CustomResourceOptions options)

type: gcp:chronicle:RuleDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RuleDeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RuleDeploymentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RuleDeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RuleDeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RuleDeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ruleDeploymentResource = new Gcp.Chronicle.RuleDeployment("ruleDeploymentResource", new()
{
    Instance = "string",
    Location = "string",
    Rule = "string",
    Alerting = false,
    Archived = false,
    Enabled = false,
    Project = "string",
    RunFrequency = "string",
});
Copy
example, err := chronicle.NewRuleDeployment(ctx, "ruleDeploymentResource", &chronicle.RuleDeploymentArgs{
	Instance:     pulumi.String("string"),
	Location:     pulumi.String("string"),
	Rule:         pulumi.String("string"),
	Alerting:     pulumi.Bool(false),
	Archived:     pulumi.Bool(false),
	Enabled:      pulumi.Bool(false),
	Project:      pulumi.String("string"),
	RunFrequency: pulumi.String("string"),
})
Copy
var ruleDeploymentResource = new RuleDeployment("ruleDeploymentResource", RuleDeploymentArgs.builder()
    .instance("string")
    .location("string")
    .rule("string")
    .alerting(false)
    .archived(false)
    .enabled(false)
    .project("string")
    .runFrequency("string")
    .build());
Copy
rule_deployment_resource = gcp.chronicle.RuleDeployment("ruleDeploymentResource",
    instance="string",
    location="string",
    rule="string",
    alerting=False,
    archived=False,
    enabled=False,
    project="string",
    run_frequency="string")
Copy
const ruleDeploymentResource = new gcp.chronicle.RuleDeployment("ruleDeploymentResource", {
    instance: "string",
    location: "string",
    rule: "string",
    alerting: false,
    archived: false,
    enabled: false,
    project: "string",
    runFrequency: "string",
});
Copy
type: gcp:chronicle:RuleDeployment
properties:
    alerting: false
    archived: false
    enabled: false
    instance: string
    location: string
    project: string
    rule: string
    runFrequency: string
Copy

RuleDeployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RuleDeployment resource accepts the following input properties:

Instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Rule
This property is required.
Changes to this property will trigger replacement.
string
The Rule ID of the rule.

Alerting bool
Whether detections resulting from this deployment should be considered alerts.
Archived 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 run_frequency cannot be updated.
Enabled bool
Whether the rule is currently deployed continuously against incoming data.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
Instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Rule
This property is required.
Changes to this property will trigger replacement.
string
The Rule ID of the rule.

Alerting bool
Whether detections resulting from this deployment should be considered alerts.
Archived 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 run_frequency cannot be updated.
Enabled bool
Whether the rule is currently deployed continuously against incoming data.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
instance
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
rule
This property is required.
Changes to this property will trigger replacement.
String
The Rule ID of the rule.

alerting Boolean
Whether detections resulting from this deployment should be considered alerts.
archived 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.
enabled Boolean
Whether the rule is currently deployed continuously against incoming data.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runFrequency String
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
rule
This property is required.
Changes to this property will trigger replacement.
string
The Rule ID of the rule.

alerting boolean
Whether detections resulting from this deployment should be considered alerts.
archived 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.
enabled boolean
Whether the rule is currently deployed continuously against incoming data.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
instance
This property is required.
Changes to this property will trigger replacement.
str
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
str
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
rule
This property is required.
Changes to this property will trigger replacement.
str
The Rule ID of the rule.

alerting bool
Whether detections resulting from this deployment should be considered alerts.
archived 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 run_frequency cannot be updated.
enabled bool
Whether the rule is currently deployed continuously against incoming data.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
run_frequency str
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
instance
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
rule
This property is required.
Changes to this property will trigger replacement.
String
The Rule ID of the rule.

alerting Boolean
Whether detections resulting from this deployment should be considered alerts.
archived 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.
enabled Boolean
Whether the rule is currently deployed continuously against incoming data.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runFrequency String
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY

Outputs

All input properties are implicitly available as output properties. Additionally, the RuleDeployment resource produces the following output properties:

ArchiveTime 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 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}
ExecutionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
Id string
The provider-assigned unique ID for this managed resource.
LastAlertStatusChangeTime 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.
Name 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 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}
ArchiveTime 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 []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}
ExecutionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
Id string
The provider-assigned unique ID for this managed resource.
LastAlertStatusChangeTime 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.
Name 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 []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}
archiveTime 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 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}
executionState String
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
id String
The provider-assigned unique ID for this managed resource.
lastAlertStatusChangeTime 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.
name 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 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}
archiveTime 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 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}
executionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
id string
The provider-assigned unique ID for this managed resource.
lastAlertStatusChangeTime 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.
name 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 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}
archive_time str
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.
consumer_rules Sequence[str]
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}
execution_state str
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
id str
The provider-assigned unique ID for this managed resource.
last_alert_status_change_time str
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.
name str
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
producer_rules Sequence[str]
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}
archiveTime 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 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}
executionState String
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
id String
The provider-assigned unique ID for this managed resource.
lastAlertStatusChangeTime 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.
name 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 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}

Look up Existing RuleDeployment Resource

Get an existing RuleDeployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RuleDeploymentState, opts?: CustomResourceOptions): RuleDeployment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alerting: Optional[bool] = None,
        archive_time: Optional[str] = None,
        archived: Optional[bool] = None,
        consumer_rules: Optional[Sequence[str]] = None,
        enabled: Optional[bool] = None,
        execution_state: Optional[str] = None,
        instance: Optional[str] = None,
        last_alert_status_change_time: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        producer_rules: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        rule: Optional[str] = None,
        run_frequency: Optional[str] = None) -> RuleDeployment
func GetRuleDeployment(ctx *Context, name string, id IDInput, state *RuleDeploymentState, opts ...ResourceOption) (*RuleDeployment, error)
public static RuleDeployment Get(string name, Input<string> id, RuleDeploymentState? state, CustomResourceOptions? opts = null)
public static RuleDeployment get(String name, Output<String> id, RuleDeploymentState state, CustomResourceOptions options)
resources:  _:    type: gcp:chronicle:RuleDeployment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Alerting bool
Whether detections resulting from this deployment should be considered alerts.
ArchiveTime 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.
Archived 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 run_frequency cannot be updated.
ConsumerRules 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 bool
Whether the rule is currently deployed continuously against incoming data.
ExecutionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
Instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
LastAlertStatusChangeTime 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 Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Name 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 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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Rule Changes to this property will trigger replacement. string
The Rule ID of the rule.

RunFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
Alerting bool
Whether detections resulting from this deployment should be considered alerts.
ArchiveTime 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.
Archived 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 run_frequency cannot be updated.
ConsumerRules []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 bool
Whether the rule is currently deployed continuously against incoming data.
ExecutionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
Instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
LastAlertStatusChangeTime 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 Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Name 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 []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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Rule Changes to this property will trigger replacement. string
The Rule ID of the rule.

RunFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
alerting Boolean
Whether detections resulting from this deployment should be considered alerts.
archiveTime 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.
archived 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.
consumerRules 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 Boolean
Whether the rule is currently deployed continuously against incoming data.
executionState String
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
instance Changes to this property will trigger replacement. String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
lastAlertStatusChangeTime 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 Changes to this property will trigger replacement. String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name 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 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 Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rule Changes to this property will trigger replacement. String
The Rule ID of the rule.

runFrequency String
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
alerting boolean
Whether detections resulting from this deployment should be considered alerts.
archiveTime 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.
archived 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.
consumerRules 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 boolean
Whether the rule is currently deployed continuously against incoming data.
executionState string
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
lastAlertStatusChangeTime 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 Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name 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 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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rule Changes to this property will trigger replacement. string
The Rule ID of the rule.

runFrequency string
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
alerting bool
Whether detections resulting from this deployment should be considered alerts.
archive_time str
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.
archived 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 run_frequency cannot be updated.
consumer_rules Sequence[str]
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 bool
Whether the rule is currently deployed continuously against incoming data.
execution_state str
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
instance Changes to this property will trigger replacement. str
The unique identifier for the Chronicle instance, which is the same as the customer ID.
last_alert_status_change_time str
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 Changes to this property will trigger replacement. str
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name str
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
producer_rules Sequence[str]
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 Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rule Changes to this property will trigger replacement. str
The Rule ID of the rule.

run_frequency str
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY
alerting Boolean
Whether detections resulting from this deployment should be considered alerts.
archiveTime 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.
archived 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.
consumerRules 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 Boolean
Whether the rule is currently deployed continuously against incoming data.
executionState String
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
instance Changes to this property will trigger replacement. String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
lastAlertStatusChangeTime 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 Changes to this property will trigger replacement. String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name 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 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 Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rule Changes to this property will trigger replacement. String
The Rule ID of the rule.

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

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
Copy
$ pulumi import gcp:chronicle/ruleDeployment:RuleDeployment default {{project}}/{{location}}/{{instance}}/{{rule}}
Copy
$ pulumi import gcp:chronicle/ruleDeployment:RuleDeployment default {{location}}/{{instance}}/{{rule}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp