- Home
- Documentation
- resources
- f5xc_cdn_cache_rule Resource - terraform-provider-f5xc
f5xc_cdn_cache_rule Resource - terraform-provider-f5xc
f5xc_cdn_cache_rule (Resource)
Section titled “f5xc_cdn_cache_rule (Resource)”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.
Example Usage
Section titled “Example Usage”# 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 configurationresource "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 }}Argument Reference
Section titled “Argument Reference”🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.
Metadata Argument Reference
Section titled “Metadata Argument Reference”• 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
Spec Argument Reference
Section titled “Spec Argument Reference”• 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.
Attributes Reference
Section titled “Attributes Reference”In addition to all arguments above, the following attributes are exported:
• id - Optional String
Unique identifier for the resource
Cache Rules
Section titled “Cache Rules”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
Cache Rules Eligible For Cache
Section titled “Cache Rules Eligible For Cache”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.
Cache Rules Rule Expression List
Section titled “Cache Rules Rule Expression List”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.
Cache Rules Rule Expression List Cache Rule Expression Cookie Matcher
Section titled “Cache Rules Rule Expression List Cache Rule Expression Cookie Matcher”Deeply nested Matcher block collapsed for readability.
Cache Rules Rule Expression List Cache Rule Expression Cookie Matcher Operator
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.
Timeouts
Section titled “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
Section titled “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}
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.
| 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}
Section titled “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}
Section titled “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}
Section titled “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}
Section titled “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
Section titled “Import”Import is supported using the following syntax:
# Import using namespace/name formatterraform import f5xc_cdn_cache_rule.example system/example