Skip to content

f5xc_cdn_cache_rule Resource - terraform-provider-f5xc

Manages a CDN Cache Rule resource in F5 Distributed Cloud for CDN loadbalancer specification. configuration.

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

# CDN Cache Rule Resource Example
# Manages a CDN Cache Rule resource in F5 Distributed Cloud for CDN loadbalancer specification. configuration.
terraform {
required_version = ">= 1.0"
required_providers {
f5xc = {
source = "f5xc-salesdemos/f5xc"
version = ">= 0.1.0"
}
}
}
# Basic CDN Cache Rule configuration
resource "f5xc_cdn_cache_rule" "example" {
name = "example-CDN-cache-rule"
namespace = "staging"
labels = {
environment = "production"
managed_by = "terraform"
}
annotations = {
"owner" = "platform-team"
}
# Resource-specific configuration
# Cache Rule. This defines a CDN Cache Rule.
cache_rules {
# Configure cache_rules settings
}
# Configuration parameter for cache bypass.
cache_bypass {
# Configure cache_bypass settings
}
# Configuration parameter for eligible for cache.
eligible_for_cache {
# Configure eligible_for_cache settings
}
}

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

name - Required String
Name of the CDN Cache Rule. Must be unique within the namespace

namespace - Required String
Namespace where the CDN Cache Rule 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

cache_rules - Optional Block
Cache Rule. This defines a CDN Cache Rule
See Cache Rules below for details.

timeouts - Optional Block
See Timeouts below for details.

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

id - Optional String
Unique identifier for the resource


A cache_rules block supports the following:

cache_bypass - Optional Block
Configuration parameter for cache bypass

eligible_for_cache - Optional Block
Configuration parameter for eligible for cache
See Eligible For Cache below.

rule_expression_list - Optional Block
Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs
See Rule Expression List below.

rule_name - Optional String
Rule Name. Name of the Cache Rule

An eligible_for_cache block (within cache_rules) supports the following:

scheme_proxy_host_request_uri - Optional Block
Cache TTL Enable Props. Cache TTL Enable Values
See Scheme Proxy Host Request URI below.

scheme_proxy_host_uri - Optional Block
Cache TTL Enable Props. Cache TTL Enable Values
See Scheme Proxy Host URI below.

Cache Rules Eligible For Cache Scheme Proxy Host Request URI

Section titled “Cache Rules Eligible For Cache Scheme Proxy Host Request URI”

Deeply nested URI block collapsed for readability.

Cache Rules Eligible For Cache Scheme Proxy Host URI

Section titled “Cache Rules Eligible For Cache Scheme Proxy Host URI”

Deeply nested URI block collapsed for readability.

A rule_expression_list block (within cache_rules) supports the following:

cache_rule_expression - Optional Block
The Cache Rule Expression Terms that are ANDed
See Cache Rule Expression below.

expression_name - Optional String
Name of the Expressions items that are ANDed

Cache Rules Rule Expression List Cache Rule Expression

Section titled “Cache Rules Rule Expression List Cache Rule Expression”

Deeply nested Expression block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Cache Headers

Section titled “Cache Rules Rule Expression List Cache Rule Expression Cache Headers”

Deeply nested Headers block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Cache Headers Operator

Section titled “Cache Rules Rule Expression List Cache Rule Expression Cache Headers Operator”

Deeply nested Operator block collapsed for readability.

Section titled “Cache Rules Rule Expression List Cache Rule Expression Cookie Matcher”

Deeply nested Matcher block collapsed for readability.

Section titled “Cache Rules Rule Expression List Cache Rule Expression Cookie Matcher Operator”

Deeply nested Operator block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Path Match

Section titled “Cache Rules Rule Expression List Cache Rule Expression Path Match”

Deeply nested Match block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Path Match Operator

Section titled “Cache Rules Rule Expression List Cache Rule Expression Path Match Operator”

Deeply nested Operator block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Query Parameters

Section titled “Cache Rules Rule Expression List Cache Rule Expression Query Parameters”

Deeply nested Parameters block collapsed for readability.

Cache Rules Rule Expression List Cache Rule Expression Query Parameters Operator

Section titled “Cache Rules Rule Expression List Cache Rule Expression Query Parameters Operator”

Deeply nested Operator block collapsed for readability.

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


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

Object Reference {#common-object-reference}

Section titled “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.

FieldTypeDescription
nameStringName of the referenced object
namespaceStringNamespace containing the referenced object
tenantStringTenant of the referenced object (system-managed)

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

ValueDescription
LOWER_CASEConvert to lowercase
UPPER_CASEConvert to uppercase
BASE64_DECODEDecodebase64 content
NORMALIZE_PATHNormalize URL path
REMOVE_WHITESPACERemove whitespace characters
URL_DECODEDecode URL-encoded characters
TRIM_LEFTTrim leading whitespace
TRIM_RIGHTTrim trailing whitespace
TRIMTrim both leading and trailing whitespace

HTTP methods used for request matching.

ValueDescription
ANYMatch any HTTP method
GETHTTP GET request
HEADHTTP HEAD request
POSTHTTP POST request
PUTHTTP PUT request
DELETEHTTP DELETE request
CONNECTHTTP CONNECT request
OPTIONSHTTP OPTIONS request
TRACEHTTP TRACE request
PATCHHTTP PATCH request
COPYHTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

Section titled “TLS Fingerprints {#common-tls-fingerprints}”

TLS fingerprint categories for malicious client detection.

ValueDescription
TLS_FINGERPRINT_NONENo fingerprint matching
ANY_MALICIOUS_FINGERPRINTMatch any known malicious fingerprint
ADWAREAdware-associated fingerprints
DRIDEXDridex malware fingerprints
GOOTKITGootkit malware fingerprints
RANSOMWARERansomware-associated fingerprints
TRICKBOTTrickbot malware fingerprints

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

Section titled “IP Threat Categories {#common-ip-threat-categories}”

IP address threat categories for security filtering.

ValueDescription
SPAM_SOURCESKnown spam sources
WINDOWS_EXPLOITSWindows exploit sources
WEB_ATTACKSWeb attack sources
BOTNETSKnown botnet IPs
SCANNERSNetwork scanner IPs
REPUTATIONPoor reputation IPs
PHISHINGPhishing-related IPs
PROXYAnonymous proxy IPs
MOBILE_THREATSMobile threat sources
TOR_PROXYTor exit nodes
DENIAL_OF_SERVICEDoS attack sources
NETWORKKnown bad network ranges

Import is supported using the following syntax:

Terminal window
# Import using namespace/name format
terraform import f5xc_cdn_cache_rule.example system/example