Rule
Rule is the Schema for the Rules API. Provides a Datadog SensitiveDataScannerRule resource. This can be used to create and manage Datadog sensitivedatascanner_rule. Setting the create_before_destroy lifecycle Meta-argument to true is highly recommended if modifying the included_keyword_configuration field to avoid unexpectedly disabling Sensitive Data Scanner groups.
TypeMR
Providerprovider-datadog
Groupsensitivedatascanner.datadog.upbound.io
Scopecluster
Versionv1alpha1

1apiVersion: sensitivedatascanner.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)

description
string
excludedNamespaces
array

path of the namespaces array. Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

groupId
string
includedKeywordConfiguration
array

argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups. (see below for nested schema) Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check then the match is kept. If none are found, the match is discarded. Setting the create_before_destroy lifecycle Meta-argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups.

characterCount
number
keywords
array

(List of String) Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30. Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30.

isEnabled
boolean
name
string
namespaces
array

(List of String) Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned. Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.

pattern
string
standardPatternId
string
tags
array

(List of String) List of tags. List of tags.

textReplacement
array

(Block List, Max: 1) Object describing how the scanned event will be replaced. Defaults to type: none (see below for nested schema) Object describing how the scanned event will be replaced. Defaults to type: none

numberOfChars
number
replacementString
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.

description
string
excludedNamespaces
array

path of the namespaces array. Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

groupId
string
includedKeywordConfiguration
array

argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups. (see below for nested schema) Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check then the match is kept. If none are found, the match is discarded. Setting the create_before_destroy lifecycle Meta-argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups.

characterCount
number
keywords
array

(List of String) Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30. Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30.

isEnabled
boolean
name
string
namespaces
array

(List of String) Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned. Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.

pattern
string
standardPatternId
string
tags
array

(List of String) List of tags. List of tags.

textReplacement
array

(Block List, Max: 1) Object describing how the scanned event will be replaced. Defaults to type: none (see below for nested schema) Object describing how the scanned event will be replaced. Defaults to type: none

numberOfChars
number
replacementString
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)

description
string
excludedNamespaces
array

path of the namespaces array. Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

groupId
string
id
string
includedKeywordConfiguration
array

argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups. (see below for nested schema) Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check then the match is kept. If none are found, the match is discarded. Setting the create_before_destroy lifecycle Meta-argument to true is highly recommended if modifying this field to avoid unexpectedly disabling Sensitive Data Scanner groups.

characterCount
number
keywords
array

(List of String) Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30. Keyword list that is checked during scanning in order to validate a match. The number of keywords in the list must be lower than or equal to 30.

isEnabled
boolean
name
string
namespaces
array

(List of String) Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned. Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.

pattern
string
standardPatternId
string
tags
array

(List of String) List of tags. List of tags.

textReplacement
array

(Block List, Max: 1) Object describing how the scanned event will be replaced. Defaults to type: none (see below for nested schema) Object describing how the scanned event will be replaced. Defaults to type: none

numberOfChars
number
replacementString
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