xcsh_data_type (Data Source)

Retrieves information about data_type creates a new object in the storage backend for metadata.namespace in F5 Distributed Cloud. This is a read-only data source.

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

Example Usage

# DataType Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing DataType by name
data "xcsh_data_type" "example" {
  name      = "example-data-type"
  namespace = "staging"
}

output "data_type_id" {
  value = data.xcsh_data_type.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.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the DataType

• namespace - Required String
Namespace where the DataType exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the DataType

• id - Optional String
Unique identifier for the resource

• is_pii - Optional Bool
Select this option to classify the custom data type as personally identifiable information (PII)

• is_sensitive_data - Optional Bool
Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type

• labels - Optional Map
Labels applied to this resource

• rules - Optional List
Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response

Rules

A rules block supports the following:

• key_pattern - Optional String
Configuration parameter for key pattern

• key_value_pattern - Optional String
Search for specific key & value patterns in the specified sections

• value_pattern - Optional String
Configuration parameter for value pattern

Rules Key Pattern

A key_pattern block (within rules) supports the following:

• exact_values - Optional String
Configuration parameter for exact values

• regex_value - Optional String
Search for values matching this regular expression

• substring_value - Optional String
Search for values that include this substring

Rules Key Pattern Exact Values

An exact_values block (within rules.key_pattern) supports the following:

• exact_values - Optional List
Exact Values. List of exact values to match

Rules Key Value Pattern

A key_value_pattern block (within rules) supports the following:

• key_pattern - Optional String
Configuration parameter for key pattern

• value_pattern - Optional String
Configuration parameter for value pattern

Rules Key Value Pattern Key Pattern

A key_pattern block (within rules.key_value_pattern) supports the following:

• exact_values - Optional String
Configuration parameter for exact values

• regex_value - Optional String
Search for values matching this regular expression

• substring_value - Optional String
Search for values that include this substring

Rules Key Value Pattern Key Pattern Exact Values

Deeply nested Values block collapsed for readability.

Rules Key Value Pattern Value Pattern

A value_pattern block (within rules.key_value_pattern) supports the following:

• exact_values - Optional String
Configuration parameter for exact values

• regex_value - Optional String
Search for values matching this regular expression

• substring_value - Optional String
Search for values that include this substring

Rules Key Value Pattern Value Pattern Exact Values

Deeply nested Values block collapsed for readability.

Rules Value Pattern

A value_pattern block (within rules) supports the following:

• exact_values - Optional String
Configuration parameter for exact values

• regex_value - Optional String
Search for values matching this regular expression

• substring_value - Optional String
Search for values that include this substring

Rules Value Pattern Exact Values

An exact_values block (within rules.value_pattern) supports the following:

• exact_values - Optional List
Exact Values. List of exact values to match

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