xcsh_bot_detection_rule (Data Source)

Retrieves information about a Bot Detection Rule resource in F5 Distributed Cloud for get bot detection rule. configuration. (read-only data source)

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# BotDetectionRule Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing BotDetectionRule by name
data "xcsh_bot_detection_rule" "example" {
  name      = "example-bot-detection-rule"
  namespace = "staging"
}

output "bot_detection_rule_id" {
  value = data.xcsh_bot_detection_rule.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

Metadata Argument Reference

• name - Required String
Name of the BotDetectionRule to look up

• namespace - Required String
Namespace of the BotDetectionRule

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• annotations - Optional Map
Annotations

• bot_detection_rule_configs_per_bot_infras - Optional List
Rule configurations per Bot-Infras. Rule or policy definition

• classification - Optional List
Classification. Classification or category data

• cluster_groups - Optional List
Cluster Groups. Cluster or grouping configuration

• created_at - Optional String
Created At. Created at as per SAPI’s database

• description - Optional String
Description

• id - Optional String
Unique identifier

• labels - Optional Map
Labels

• last_modified_at - Optional String
Last modified at as per SAPI’s database

• last_modified_by - Optional String
Last Modified By as per SAPI’s database

• rule_name - Optional String
Rule Name. Human-readable name for the resource

• rule_type - Optional String Defaults to BOT_DETECTION_RULE_TYPE_UNKNOWN
Possible values are BOT_DETECTION_RULE_TYPE_UNKNOWN, BOT_DETECTION_RULE_TYPE_ENFORCED_BLOCKING, BOT_DETECTION_RULE_TYPE_CONTROL_BLOCKING
[Enum: BOT_DETECTION_RULE_TYPE_UNKNOWN|BOT_DETECTION_RULE_TYPE_ENFORCED_BLOCKING|BOT_DETECTION_RULE_TYPE_CONTROL_BLOCKING] Bot Detection Rule Type

• traffic_type - Optional String Defaults to WEB
Possible values are WEB, MOBILE
[Enum: WEB|MOBILE] The type of traffic that is routed to and processed by this infrastructure (Web or Mobile). Only web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure. Only mobile traffic from native mobile apps with the Bot Defense SDK are routed

• version - Optional Number
Version. Version number or identifier

• bot_detection_rule_config - Optional String
Rule configuration. Rule configuration

• bot_infra_id - Optional String
Bot Infrastructure ID as per SAPI’s database

• bot_infra_name - Optional String
Name of the bot infrastructure as per SAPI’s database

• bot_infrastructure_type - Optional String Defaults to BOT_INFRA_TYPE_UNKNOWN
Possible values are BOT_INFRA_TYPE_UNKNOWN, BOT_INFRA_TYPE_CLOUD_HOSTED, BOT_INFRA_TYPE_HOSTED, BOT_INFRA_TYPE_ON_PREM, BOT_INFRA_TYPE_K8S_CLUSTER
[Enum: BOT_INFRA_TYPE_UNKNOWN|BOT_INFRA_TYPE_CLOUD_HOSTED|BOT_INFRA_TYPE_HOSTED|BOT_INFRA_TYPE_ON_PREM|BOT_INFRA_TYPE_K8S_CLUSTER] Type of the Bot Infrastructure - BOT_INFRA_TYPE_UNKNOWN: Unknown - BOT_INFRA_TYPE_CLOUD_HOSTED: F5 Cloud Hosted - BOT_INFRA_TYPE_HOSTED: F5 Hosted - BOT_INFRA_TYPE_ON_PREM: F5 On Premises - BOT_INFRA_TYPE_K8S_CLUSTER: Kubernetes Cluster

• environment_type - Optional String Defaults to PRODUCTION
Possible values are PRODUCTION, TESTING
[Enum: PRODUCTION|TESTING] Identifies the environment as either Production or Testing. Production environments have two infrastructure regions in an Active-Active configuration where traffic is routed equally between the two regions. Test environments have a single infrastructure region

• k8s_cluster_rule_config - Optional String
Kubernetes Cluster Rule Config. Kubernetes cluster rule config

• region_rule_config - Optional String
Rule Config Per Region. Rule config per region

• mitigation - Optional Bool
Mitigation. Mitigation - true(ON) / false(OFF)

• in_used_k8s_cluster_rule_config - Optional String
In-Used Kubernetes Cluster Rule Config. Cluster or grouping configuration

• sync_status_per_k8s_cluster - Optional String
Sync Status. Cluster or grouping configuration

• target_k8s_cluster_rule_config - Optional String
Target Kubernetes Cluster Rule Config. Cluster or grouping configuration

• region_config - Optional String
Rule Config Per Region. Configuration settings and parameters

---

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
name	String	Name of the referenced object
namespace	String	Namespace containing the referenced object
tenant	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
LOWER_CASE	Convert to lowercase
UPPER_CASE	Convert to uppercase
BASE64_DECODE	Decodebase64 content
NORMALIZE_PATH	Normalize URL path
REMOVE_WHITESPACE	Remove whitespace characters
URL_DECODE	Decode URL-encoded characters
TRIM_LEFT	Trim leading whitespace
TRIM_RIGHT	Trim trailing whitespace
TRIM	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
ANY	Match any HTTP method
GET	HTTP GET request
HEAD	HTTP HEAD request
POST	HTTP POST request
PUT	HTTP PUT request
DELETE	HTTP DELETE request
CONNECT	HTTP CONNECT request
OPTIONS	HTTP OPTIONS request
TRACE	HTTP TRACE request
PATCH	HTTP PATCH request
COPY	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
TLS_FINGERPRINT_NONE	No fingerprint matching
ANY_MALICIOUS_FINGERPRINT	Match any known malicious fingerprint
ADWARE	Adware-associated fingerprints
DRIDEX	Dridex malware fingerprints
GOOTKIT	Gootkit malware fingerprints
RANSOMWARE	Ransomware-associated fingerprints
TRICKBOT	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
SPAM_SOURCES	Known spam sources
WINDOWS_EXPLOITS	Windows exploit sources
WEB_ATTACKS	Web attack sources
BOTNETS	Known botnet IPs
SCANNERS	Network scanner IPs
REPUTATION	Poor reputation IPs
PHISHING	Phishing-related IPs
PROXY	Anonymous proxy IPs
MOBILE_THREATS	Mobile threat sources
TOR_PROXY	Tor exit nodes
DENIAL_OF_SERVICE	DoS attack sources
NETWORK	Known bad network ranges