xcsh_app_setting (Resource)

Manages App setting configuration in namespace metadata.namespace in F5 Distributed Cloud.

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

Example Usage

# AppSetting Resource Example
# Manages App setting configuration in namespace metadata.namespace in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

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

# Basic AppSetting configuration
resource "xcsh_app_setting" "example" {
  name      = "example-app-setting"
  namespace = "staging"
}

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 App Setting. Must be unique within the namespace

• namespace - Required String
Namespace where the App Setting is 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 administratively disables 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

• app_type_settings - Optional Block
List of settings to enable for each AppType, given instance of AppType Exist in this Namespace
See App Type Settings 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

---

App Type Settings

An app_type_settings block supports the following:

• app_type_ref - Optional Block
The AppType of App instance in current Namespace. Associating an AppType reference, will enable analysis on this instance’s generated data
See App Type Ref below.

• business_logic_markup_setting - Optional Block
Settings specifying how API Discovery will be performed
See Business Logic Markup Setting below.

• timeseries_analyses_setting - Optional Block
Configuration parameter for timeseries analyses setting
See Timeseries Analyses Setting below.

• user_behavior_analysis_setting - Optional Block
Configuration for user behavior analysis
See User Behavior Analysis Setting below.

App Type Settings App Type Ref

An app_type_ref block (within app_type_settings) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid

App Type Settings Business Logic Markup Setting

A business_logic_markup_setting block (within app_type_settings) supports the following:

• disable_spec - Optional Object
Enable this option

• enable - Optional Object
Enable this option

App Type Settings Business Logic Markup Setting Disable Spec

Deeply nested Spec block collapsed for readability.

App Type Settings Business Logic Markup Setting Enable

Deeply nested Enable block collapsed for readability.

App Type Settings Timeseries Analyses Setting

A timeseries_analyses_setting block (within app_type_settings) supports the following:

• metric_selectors - Optional Block
Define the metric selection criteria, i.e. The metrics source and the actual metrics that should be included in the detection logic
See Metric Selectors below.

App Type Settings Timeseries Analyses Setting Metric Selectors

Deeply nested Selectors block collapsed for readability.

App Type Settings User Behavior Analysis Setting

An user_behavior_analysis_setting block (within app_type_settings) supports the following:

• disable_detection - Optional Object
Configuration parameter for disable detection

• disable_learning - Optional Object
Configuration parameter for disable learning

• enable_detection - Optional Block
Various factors about user activity are monitored and analysed to determine malicious users. These settings allow tuning those factors used by the system to detect malicious users
See Enable Detection below.

• enable_learning - Optional Object
Configuration parameter for enable learning

App Type Settings User Behavior Analysis Setting Disable Detection

Deeply nested Detection block collapsed for readability.

App Type Settings User Behavior Analysis Setting Disable Learning

Deeply nested Learning block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection

Deeply nested Detection block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Bola Detection Automatic

Deeply nested Automatic block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Bola Detection

Deeply nested Detection block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Bot Defense Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Failed Login Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Forbidden Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude IP Reputation

Deeply nested Reputation block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Non Existent URL Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude Rate Limit

Deeply nested Limit block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Exclude WAF Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Bot Defense Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Failed Login Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Forbidden Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include IP Reputation

Deeply nested Reputation block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Non Existent URL Activity Automatic

Deeply nested Automatic block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Non Existent URL Activity Automatic High

Deeply nested High block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Non Existent URL Activity Automatic Low

Deeply nested Low block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Non Existent URL Activity Automatic Medium

Deeply nested Medium block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Non Existent URL Activity Custom

Deeply nested Custom block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include Rate Limit

Deeply nested Limit block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Detection Include WAF Activity

Deeply nested Activity block collapsed for readability.

App Type Settings User Behavior Analysis Setting Enable Learning

Deeply nested Learning block collapsed for readability.

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