f5xc_data_type Resource - terraform-provider-f5xc

f5xc_data_type (Resource)

Manages data_type creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# Data Type Resource Example
# Manages data_type creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic Data Type configuration
resource "f5xc_data_type" "example" {
  name      = "example-data-type"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Resource-specific configuration
  # Configure key/value or regex match rules to enable the pl...
  rules {
    # Configure rules settings
  }
  # Configuration parameter for key pattern.
  key_pattern {
    # Configure key_pattern settings
  }
  # Configuration parameter for exact values.
  exact_values {
    # Configure exact_values settings
  }
}

Argument Reference

🔶 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 Data Type. Must be unique within the namespace

• namespace - Required String
Namespace where the Data Type will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

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

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

• rules - Optional Block
Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response
See Rules below for details.

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

Rules

A rules block supports the following:

• key_pattern - Optional Block
Configuration parameter for key pattern
See Key Pattern below.

• key_value_pattern - Optional Block
Search for specific key & value patterns in the specified sections
See Key Value Pattern below.

• value_pattern - Optional Block
Configuration parameter for value pattern
See Value Pattern below.

Rules Key Pattern

A key_pattern block (within rules) supports the following:

• exact_values - Optional Block
Configuration parameter for exact values
See Exact Values below.

• 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
List of exact values to match

Rules Key Value Pattern

A key_value_pattern block (within rules) supports the following:

• key_pattern - Optional Block
Configuration parameter for key pattern
See Key Pattern below.

• value_pattern - Optional Block
Configuration parameter for value pattern
See Value Pattern below.

Rules Key Value Pattern Key Pattern

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

• exact_values - Optional Block
Configuration parameter for exact values
See Exact Values below.

• 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 Block
Configuration parameter for exact values
See Exact Values below.

• 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 Block
Configuration parameter for exact values
See Exact Values below.

• 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
List of exact values to match

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

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

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_data_type.example system/example