Rule
Rule is the Schema for the Rules API. Provides a Datadog Security Monitoring Rule API resource. This can be used to create and manage Datadog security monitoring rules. To change settings for a default rule use datadog_security_default_rule instead.
TypeMR
Providerprovider-datadog
Groupsecuritymonitoring.datadog.upbound.io
Scopecluster
Versionv1alpha1

1apiVersion: securitymonitoring.datadog.upbound.io/v1alpha1

2kind: Rule

apiVersion
string
kind
string
metadata
object
spec
object

RuleSpec defines the desired state of Rule

deletionPolicy
string
forProvider
required
object

(No description available)

case
array

(Block List, Max: 10) Cases for generating signals. (see below for nested schema) Cases for generating signals.

condition
string
name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

status
string
enabled
boolean
filter
array

(Block List) Additional queries to filter matched events before they are processed. (see below for nested schema) Additional queries to filter matched events before they are processed.

action
string
query
string
hasExtendedTitle
boolean
message
string
name
string
options
array

(Block List, Max: 1) Options on rules. (see below for nested schema) Options on rules.

decreaseCriticalityBasedOnEnv
boolean
detectionMethod
string
evaluationWindow
number
impossibleTravelOptions
array

(Block List, Max: 1) Options for rules using the impossible travel detection method. (see below for nested schema) Options for rules using the impossible travel detection method.

baselineUserLocations
boolean
keepAlive
number
maxSignalDuration
number
newValueOptions
array

(Block List, Max: 1) New value rules specific options. (see below for nested schema) New value rules specific options.

forgetAfter
number
learningDuration
number
learningMethod
string
learningThreshold
number
thirdPartyRuleOptions
array

party detection method. (see below for nested schema) Options for rules using the third-party detection method.

defaultNotifications
array

party cases match. Notification targets for the default rule case, when none of the third-party cases match.

defaultStatus
string
rootQuery
array

party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert. (see below for nested schema) Queries to be combined with third-party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by. If empty, each log triggers a signal.

query
string
signalTitleTemplate
string
query
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

agentRule
array

(Block List, Deprecated) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource. (see below for nested schema) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource.

agentRuleId
string
expression
string
aggregation
string
distinctFields
array

(List of String) Field for which the cardinality is measured. Sent as an array. Field for which the cardinality is measured. Sent as an array.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by.

metric
string
metrics
array

(List of String) Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values. Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values.

name
string
query
string
signalQuery
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

aggregation
string
correlatedByFields
array

(List of String) Fields to correlate by. Fields to correlate by.

correlatedQueryIndex
string
defaultRuleId
string
name
string
ruleId
string
tags
array

(Set of String) Tags for generated signals. Tags for generated signals.

thirdPartyCase
array

party rules. Only required and accepted for third-party rules (see below for nested schema) Cases for generating signals for third-party rules. Only required and accepted for third-party rules

name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

query
string
status
string
type
string
initProvider
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

case
array

(Block List, Max: 10) Cases for generating signals. (see below for nested schema) Cases for generating signals.

condition
string
name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

status
string
enabled
boolean
filter
array

(Block List) Additional queries to filter matched events before they are processed. (see below for nested schema) Additional queries to filter matched events before they are processed.

action
string
query
string
hasExtendedTitle
boolean
message
string
name
string
options
array

(Block List, Max: 1) Options on rules. (see below for nested schema) Options on rules.

decreaseCriticalityBasedOnEnv
boolean
detectionMethod
string
evaluationWindow
number
impossibleTravelOptions
array

(Block List, Max: 1) Options for rules using the impossible travel detection method. (see below for nested schema) Options for rules using the impossible travel detection method.

baselineUserLocations
boolean
keepAlive
number
maxSignalDuration
number
newValueOptions
array

(Block List, Max: 1) New value rules specific options. (see below for nested schema) New value rules specific options.

forgetAfter
number
learningDuration
number
learningMethod
string
learningThreshold
number
thirdPartyRuleOptions
array

party detection method. (see below for nested schema) Options for rules using the third-party detection method.

defaultNotifications
array

party cases match. Notification targets for the default rule case, when none of the third-party cases match.

defaultStatus
string
rootQuery
array

party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert. (see below for nested schema) Queries to be combined with third-party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by. If empty, each log triggers a signal.

query
string
signalTitleTemplate
string
query
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

agentRule
array

(Block List, Deprecated) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource. (see below for nested schema) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource.

agentRuleId
string
expression
string
aggregation
string
distinctFields
array

(List of String) Field for which the cardinality is measured. Sent as an array. Field for which the cardinality is measured. Sent as an array.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by.

metric
string
metrics
array

(List of String) Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values. Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values.

name
string
query
string
signalQuery
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

aggregation
string
correlatedByFields
array

(List of String) Fields to correlate by. Fields to correlate by.

correlatedQueryIndex
string
defaultRuleId
string
name
string
ruleId
string
tags
array

(Set of String) Tags for generated signals. Tags for generated signals.

thirdPartyCase
array

party rules. Only required and accepted for third-party rules (see below for nested schema) Cases for generating signals for third-party rules. Only required and accepted for third-party rules

name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

query
string
status
string
type
string
managementPolicies
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

providerConfigRef
object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
required
string
policy
object

Policies for referencing.

resolution
string
resolve
string
publishConnectionDetailsTo
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
required
string
policy
object

Policies for referencing.

resolution
string
resolve
string
metadata
object

Metadata is the metadata for connection secret.

annotations
object
labels
object
type
string
name
required
string
writeConnectionSecretToRef
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
required
string
namespace
required
string
status
object

RuleStatus defines the observed state of Rule.

atProvider
object

(No description available)

case
array

(Block List, Max: 10) Cases for generating signals. (see below for nested schema) Cases for generating signals.

condition
string
name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

status
string
enabled
boolean
filter
array

(Block List) Additional queries to filter matched events before they are processed. (see below for nested schema) Additional queries to filter matched events before they are processed.

action
string
query
string
hasExtendedTitle
boolean
id
string
message
string
name
string
options
array

(Block List, Max: 1) Options on rules. (see below for nested schema) Options on rules.

decreaseCriticalityBasedOnEnv
boolean
detectionMethod
string
evaluationWindow
number
impossibleTravelOptions
array

(Block List, Max: 1) Options for rules using the impossible travel detection method. (see below for nested schema) Options for rules using the impossible travel detection method.

baselineUserLocations
boolean
keepAlive
number
maxSignalDuration
number
newValueOptions
array

(Block List, Max: 1) New value rules specific options. (see below for nested schema) New value rules specific options.

forgetAfter
number
learningDuration
number
learningMethod
string
learningThreshold
number
thirdPartyRuleOptions
array

party detection method. (see below for nested schema) Options for rules using the third-party detection method.

defaultNotifications
array

party cases match. Notification targets for the default rule case, when none of the third-party cases match.

defaultStatus
string
rootQuery
array

party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert. (see below for nested schema) Queries to be combined with third-party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by. If empty, each log triggers a signal.

query
string
signalTitleTemplate
string
query
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

agentRule
array

(Block List, Deprecated) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource. (see below for nested schema) Deprecated. It won't be applied anymore. Deprecated. agent_rule has been deprecated in favor of new Agent Rule resource.

agentRuleId
string
expression
string
aggregation
string
distinctFields
array

(List of String) Field for which the cardinality is measured. Sent as an array. Field for which the cardinality is measured. Sent as an array.

groupByFields
array

(List of String) Fields to group by. If empty, each log triggers a signal. Fields to group by.

metric
string
metrics
array

(List of String) Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values. Group of target fields to aggregate over when using the sum, max, geo_data, or new_value aggregations. The sum, max, and geo_data aggregations only accept one value in this list, whereas the new_value aggregation accepts up to five values.

name
string
query
string
signalQuery
array

(Block List) Queries for selecting logs which are part of the rule. (see below for nested schema) Queries for selecting logs which are part of the rule.

aggregation
string
correlatedByFields
array

(List of String) Fields to correlate by. Fields to correlate by.

correlatedQueryIndex
string
defaultRuleId
string
name
string
ruleId
string
tags
array

(Set of String) Tags for generated signals. Tags for generated signals.

thirdPartyCase
array

party rules. Only required and accepted for third-party rules (see below for nested schema) Cases for generating signals for third-party rules. Only required and accepted for third-party rules

name
string
notifications
array

(List of String) Notification targets for each rule case. Notification targets for each rule case.

query
string
status
string
type
string
conditions
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string
Discover the building blocks for your internal cloud platform.
© 2026 Upbound, Inc.
Solutions
Learn
Company
Community
More