Skip to content

f5xc_filter_set Resource - terraform-provider-f5xc

Manages specification. in F5 Distributed Cloud.

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

# Filter Set Resource Example
# Manages specification. in F5 Distributed Cloud.
terraform {
required_version = ">= 1.0"
required_providers {
f5xc = {
source = "f5xc-salesdemos/f5xc"
version = ">= 0.1.0"
}
}
}
# Basic Filter Set configuration
resource "f5xc_filter_set" "example" {
name = "example-filter-set"
namespace = "staging"
labels = {
environment = "production"
managed_by = "terraform"
}
annotations = {
"owner" = "platform-team"
}
# Resource-specific configuration
# List of fields and their values selected by the user .
filter_fields {
# Configure filter_fields settings
}
# Either an absolute time range or a relative time interval.
date_field {
# Configure date_field settings
}
# Date range is for selecting a date range.
absolute {
# Configure absolute settings
}
}

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

name - Required String
Name of the Filter Set. Must be unique within the namespace

namespace - Required String
Namespace where the Filter Set 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

context_key - Required String
Indexable context key that identifies a page or page type for which the FilterSet is applicable

filter_fields - Optional Block
List of fields and their values selected by the user
See Filter Fields 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 filter_fields block supports the following:

date_field - Optional Block
Either an absolute time range or a relative time interval
See Date Field below.

field_id - Optional String
Identifier for the field that maps to some UI filter component

filter_expression_field - Optional Block
Filter Expression Field
See Filter Expression Field below.

string_field - Optional Block
Filter String Field
See String Field below.

A date_field block (within filter_fields) supports the following:

absolute - Optional Block
Date range is for selecting a date range
See Absolute below.

relative - Optional String
relative time duration

An absolute block (within filter_fields.date_field) supports the following:

end_date - Optional String
End Date. Contains end date

start_date - Optional String
Start Date. Contains start date

A filter_expression_field block (within filter_fields) supports the following:

expression - Optional String
Expression is a Kubernetes style label expression for selections, but differs in that it allows special characters in the keys and values

A string_field block (within filter_fields) supports the following:

field_values - Optional List
String Value(s)

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_filter_set.example system/example