- Home
- Documentation
- resources
- f5xc_bot_defense_app_infrastructure Resource - terraform-provider-f5xc
f5xc_bot_defense_app_infrastructure Resource - terraform-provider-f5xc
f5xc_bot_defense_app_infrastructure (Resource)
Section titled “f5xc_bot_defense_app_infrastructure (Resource)”Manages Bot Defense App Infrastructure in a given namespace. in F5 Distributed Cloud.
~> Note For more information about this resource, please refer to the F5 XC API Documentation.
Example Usage
Section titled “Example Usage”# Bot Defense App Infrastructure Resource Example# Manages Bot Defense App Infrastructure in a given namespace. in F5 Distributed Cloud.
terraform { required_version = ">= 1.0"
required_providers { f5xc = { source = "f5xc-salesdemos/f5xc" version = ">= 0.1.0" } }}
# Basic Bot Defense App Infrastructure configurationresource "f5xc_bot_defense_app_infrastructure" "example" { name = "example-bot-defense-app-infrastructure" namespace = "staging"
labels = { environment = "production" managed_by = "terraform" }
annotations = { "owner" = "platform-team" }
# Resource-specific configuration # [OneOf: cloud_hosted, data_center_hosted] F5 Hosted. Infr... cloud_hosted { # Configure cloud_hosted settings } # Egress. Egress . egress { # Configure egress settings } # Ingress. Ingress . ingress { # Configure ingress 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 Bot Defense App Infrastructure. Must be unique within the namespace
• namespace - Required String
Namespace where the Bot Defense App Infrastructure 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”-> One of the following:
• cloud_hosted - Optional Block
F5 Hosted. Infra F5 Hosted
See Cloud Hosted below for details.
• data_center_hosted - Optional Block
F5 Hosted. Infra F5 Hosted
See Data Center Hosted below for details.
• environment_type - Required String Defaults to PRODUCTION
Possible values are PRODUCTION, TESTING
[Enum: PRODUCTION|TESTING] Environment Type Production environment Testing environment
• timeouts - Optional Block
See Timeouts below for details.
• traffic_type - Required String Defaults to WEB
Possible values are WEB, MOBILE
[Enum: WEB|MOBILE] Traffic Type Web traffic Mobile traffic
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
Cloud Hosted
Section titled “Cloud Hosted”A cloud_hosted block supports the following:
• egress - Optional Block
Egress. Egress
See Egress below.
• infra_host_name - Optional String
Infra hostname. Infra hostname
• ingress - Optional Block
Ingress. Ingress
See Ingress below.
• region - Optional String Defaults to US
Possible values are US, EU, ASIA
[Enum: US|EU|ASIA] Defines a selection for Bot Defense Advanced region - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region
Cloud Hosted Egress
Section titled “Cloud Hosted Egress”An egress block (within cloud_hosted) supports the following:
• ip_address - Optional String
IP Address. Egress IP address
• location - Optional String Defaults to AWS_AP_NORTHEAST_1
Possible values are AWS_AP_NORTHEAST_1, AWS_AP_NORTHEAST_3, AWS_AP_SOUTH_1, AWS_AP_SOUTH_2, AWS_AP_SOUTHEAST_1, AWS_AP_SOUTHEAST_2, AWS_AP_SOUTHEAST_3, AWS_EU_CENTRAL_1, AWS_EU_NORTH_1, AWS_EU_WEST_1, AWS_ME_SOUTH_1,
AWS_SA_EAST_1, AWS_US_EAST_1, AWS_US_EAST_2, AWS_US_WEST_1, AWS_US_WEST_2, GCP_ASIA_EAST_1, GCP_ASIA_EAST_2, GCP_ASIA_NORTHEAST_1, GCP_ASIA_NORTHEAST_2, GCP_ASIA_NORTHEAST_3, GCP_ASIA_SOUTH_1, GCP_ASIA_SOUTHEAST_1, GCP_ASIA_SOUTHEAST_2, GCP_AUSTRALIA_SOUTHEAST_1, GCP_EUROPE_WEST_1, GCP_EUROPE_WEST_2, GCP_EUROPE_WEST_3, GCP_NORTHAMERICA_NORTHEAST_1,
GCP_NORTHAMERICA_NORTHEAST_2, GCP_SOUTHAMERICA_EAST_1, GCP_SOUTHAMERICA_WEST_1, GCP_US_CENTRAL_1, GCP_US_EAST_1, GCP_US_EAST_4, GCP_US_WEST_1, GCP_US_WEST_2
[Enum:
AWS_AP_NORTHEAST_1|AWS_AP_NORTHEAST_3|AWS_AP_SOUTH_1|AWS_AP_SOUTH_2|AWS_AP_SOUTHEAST_1|AWS_AP_SOUTHEAST_2|AWS_AP_SOUTHEAST_3|AWS_EU_CENTRAL_1|AWS_EU_NORTH_1|AWS_EU_WEST_1|AWS_ME_SOUTH_1|AWS_SA_EAST_1|AWS_US_EAST_1|AWS_US_EAST_2|AWS_US_WEST_1|AWS_US_WEST_2|GCP_ASIA_EAST_1|GCP_ASIA_EAST_2|GCP_ASIA_NORTHEAST_1|GCP_ASIA_NORTHEAST_2|GCP_ASIA_NORTHEAST_3|GCP_ASIA_SOUTH_1|GCP_ASIA_SOUTHEAST_1|GCP_ASIA_SOUTHEAST_2|GCP_AUSTRALIA_SOUTHEAST_1|GCP_EUROPE_WEST_1|GCP_EUROPE_WEST_2|GCP_EUROPE_WEST_3|GCP_NORTHAMERICA_NORTHEAST_1|GCP_NORTHAMERICA_NORTHEAST_2|GCP_SOUTHAMERICA_EAST_1|GCP_SOUTHAMERICA_WEST_1|GCP_US_CENTRAL_1|GCP_US_EAST_1|GCP_US_EAST_4|GCP_US_WEST_1|GCP_US_WEST_2]
Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3 AWS_EU_CENTRAL_1 AWS_EU_NORTH_1 AWS_EU_WEST_1 AWS_ME_SOUTH_1 AWS_SA_EAST_1 AWS_US_EAST_1 AWS_US_EAST_2 AWS_US_WEST_1 AWS_US_WEST_2 GCP_ASIA_EAST_1
Cloud Hosted Ingress
Section titled “Cloud Hosted Ingress”An ingress block (within cloud_hosted) supports the following:
• host_name - Optional String
Ingress hostname
• ip_address - Optional String
Ingress IP Address
• location - Optional String Defaults to AWS_AP_NORTHEAST_1
Possible values are AWS_AP_NORTHEAST_1, AWS_AP_NORTHEAST_3, AWS_AP_SOUTH_1, AWS_AP_SOUTH_2, AWS_AP_SOUTHEAST_1, AWS_AP_SOUTHEAST_2, AWS_AP_SOUTHEAST_3, AWS_EU_CENTRAL_1, AWS_EU_NORTH_1, AWS_EU_WEST_1, AWS_ME_SOUTH_1,
AWS_SA_EAST_1, AWS_US_EAST_1, AWS_US_EAST_2, AWS_US_WEST_1, AWS_US_WEST_2, GCP_ASIA_EAST_1, GCP_ASIA_EAST_2, GCP_ASIA_NORTHEAST_1, GCP_ASIA_NORTHEAST_2, GCP_ASIA_NORTHEAST_3, GCP_ASIA_SOUTH_1, GCP_ASIA_SOUTHEAST_1, GCP_ASIA_SOUTHEAST_2, GCP_AUSTRALIA_SOUTHEAST_1, GCP_EUROPE_WEST_1, GCP_EUROPE_WEST_2, GCP_EUROPE_WEST_3, GCP_NORTHAMERICA_NORTHEAST_1,
GCP_NORTHAMERICA_NORTHEAST_2, GCP_SOUTHAMERICA_EAST_1, GCP_SOUTHAMERICA_WEST_1, GCP_US_CENTRAL_1, GCP_US_EAST_1, GCP_US_EAST_4, GCP_US_WEST_1, GCP_US_WEST_2
[Enum:
AWS_AP_NORTHEAST_1|AWS_AP_NORTHEAST_3|AWS_AP_SOUTH_1|AWS_AP_SOUTH_2|AWS_AP_SOUTHEAST_1|AWS_AP_SOUTHEAST_2|AWS_AP_SOUTHEAST_3|AWS_EU_CENTRAL_1|AWS_EU_NORTH_1|AWS_EU_WEST_1|AWS_ME_SOUTH_1|AWS_SA_EAST_1|AWS_US_EAST_1|AWS_US_EAST_2|AWS_US_WEST_1|AWS_US_WEST_2|GCP_ASIA_EAST_1|GCP_ASIA_EAST_2|GCP_ASIA_NORTHEAST_1|GCP_ASIA_NORTHEAST_2|GCP_ASIA_NORTHEAST_3|GCP_ASIA_SOUTH_1|GCP_ASIA_SOUTHEAST_1|GCP_ASIA_SOUTHEAST_2|GCP_AUSTRALIA_SOUTHEAST_1|GCP_EUROPE_WEST_1|GCP_EUROPE_WEST_2|GCP_EUROPE_WEST_3|GCP_NORTHAMERICA_NORTHEAST_1|GCP_NORTHAMERICA_NORTHEAST_2|GCP_SOUTHAMERICA_EAST_1|GCP_SOUTHAMERICA_WEST_1|GCP_US_CENTRAL_1|GCP_US_EAST_1|GCP_US_EAST_4|GCP_US_WEST_1|GCP_US_WEST_2]
Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3 AWS_EU_CENTRAL_1 AWS_EU_NORTH_1 AWS_EU_WEST_1 AWS_ME_SOUTH_1 AWS_SA_EAST_1 AWS_US_EAST_1 AWS_US_EAST_2 AWS_US_WEST_1 AWS_US_WEST_2 GCP_ASIA_EAST_1
Data Center Hosted
Section titled “Data Center Hosted”A data_center_hosted block supports the following:
• egress - Optional Block
Egress. Egress
See Egress below.
• infra_host_name - Optional String
Infra hostname. Infra hostname
• ingress - Optional Block
Ingress. Ingress
See Ingress below.
• region - Optional String Defaults to US
Possible values are US, EU, ASIA
[Enum: US|EU|ASIA] Defines a selection for Bot Defense Advanced region - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region
Data Center Hosted Egress
Section titled “Data Center Hosted Egress”An egress block (within data_center_hosted) supports the following:
• ip_address - Optional String
IP Address. Egress IP address
• location - Optional String Defaults to AWS_AP_NORTHEAST_1
Possible values are AWS_AP_NORTHEAST_1, AWS_AP_NORTHEAST_3, AWS_AP_SOUTH_1, AWS_AP_SOUTH_2, AWS_AP_SOUTHEAST_1, AWS_AP_SOUTHEAST_2, AWS_AP_SOUTHEAST_3, AWS_EU_CENTRAL_1, AWS_EU_NORTH_1, AWS_EU_WEST_1, AWS_ME_SOUTH_1,
AWS_SA_EAST_1, AWS_US_EAST_1, AWS_US_EAST_2, AWS_US_WEST_1, AWS_US_WEST_2, GCP_ASIA_EAST_1, GCP_ASIA_EAST_2, GCP_ASIA_NORTHEAST_1, GCP_ASIA_NORTHEAST_2, GCP_ASIA_NORTHEAST_3, GCP_ASIA_SOUTH_1, GCP_ASIA_SOUTHEAST_1, GCP_ASIA_SOUTHEAST_2, GCP_AUSTRALIA_SOUTHEAST_1, GCP_EUROPE_WEST_1, GCP_EUROPE_WEST_2, GCP_EUROPE_WEST_3, GCP_NORTHAMERICA_NORTHEAST_1,
GCP_NORTHAMERICA_NORTHEAST_2, GCP_SOUTHAMERICA_EAST_1, GCP_SOUTHAMERICA_WEST_1, GCP_US_CENTRAL_1, GCP_US_EAST_1, GCP_US_EAST_4, GCP_US_WEST_1, GCP_US_WEST_2
[Enum:
AWS_AP_NORTHEAST_1|AWS_AP_NORTHEAST_3|AWS_AP_SOUTH_1|AWS_AP_SOUTH_2|AWS_AP_SOUTHEAST_1|AWS_AP_SOUTHEAST_2|AWS_AP_SOUTHEAST_3|AWS_EU_CENTRAL_1|AWS_EU_NORTH_1|AWS_EU_WEST_1|AWS_ME_SOUTH_1|AWS_SA_EAST_1|AWS_US_EAST_1|AWS_US_EAST_2|AWS_US_WEST_1|AWS_US_WEST_2|GCP_ASIA_EAST_1|GCP_ASIA_EAST_2|GCP_ASIA_NORTHEAST_1|GCP_ASIA_NORTHEAST_2|GCP_ASIA_NORTHEAST_3|GCP_ASIA_SOUTH_1|GCP_ASIA_SOUTHEAST_1|GCP_ASIA_SOUTHEAST_2|GCP_AUSTRALIA_SOUTHEAST_1|GCP_EUROPE_WEST_1|GCP_EUROPE_WEST_2|GCP_EUROPE_WEST_3|GCP_NORTHAMERICA_NORTHEAST_1|GCP_NORTHAMERICA_NORTHEAST_2|GCP_SOUTHAMERICA_EAST_1|GCP_SOUTHAMERICA_WEST_1|GCP_US_CENTRAL_1|GCP_US_EAST_1|GCP_US_EAST_4|GCP_US_WEST_1|GCP_US_WEST_2]
Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3 AWS_EU_CENTRAL_1 AWS_EU_NORTH_1 AWS_EU_WEST_1 AWS_ME_SOUTH_1 AWS_SA_EAST_1 AWS_US_EAST_1 AWS_US_EAST_2 AWS_US_WEST_1 AWS_US_WEST_2 GCP_ASIA_EAST_1
Data Center Hosted Ingress
Section titled “Data Center Hosted Ingress”An ingress block (within data_center_hosted) supports the following:
• host_name - Optional String
Ingress hostname
• ip_address - Optional String
Ingress IP Address
• location - Optional String Defaults to AWS_AP_NORTHEAST_1
Possible values are AWS_AP_NORTHEAST_1, AWS_AP_NORTHEAST_3, AWS_AP_SOUTH_1, AWS_AP_SOUTH_2, AWS_AP_SOUTHEAST_1, AWS_AP_SOUTHEAST_2, AWS_AP_SOUTHEAST_3, AWS_EU_CENTRAL_1, AWS_EU_NORTH_1, AWS_EU_WEST_1,
AWS_ME_SOUTH_1, AWS_SA_EAST_1, AWS_US_EAST_1, AWS_US_EAST_2, AWS_US_WEST_1, AWS_US_WEST_2, GCP_ASIA_EAST_1, GCP_ASIA_EAST_2, GCP_ASIA_NORTHEAST_1, GCP_ASIA_NORTHEAST_2, GCP_ASIA_NORTHEAST_3, GCP_ASIA_SOUTH_1, GCP_ASIA_SOUTHEAST_1, GCP_ASIA_SOUTHEAST_2, GCP_AUSTRALIA_SOUTHEAST_1, GCP_EUROPE_WEST_1, GCP_EUROPE_WEST_2, GCP_EUROPE_WEST_3,
GCP_NORTHAMERICA_NORTHEAST_1, GCP_NORTHAMERICA_NORTHEAST_2, GCP_SOUTHAMERICA_EAST_1, GCP_SOUTHAMERICA_WEST_1, GCP_US_CENTRAL_1, GCP_US_EAST_1, GCP_US_EAST_4, GCP_US_WEST_1, GCP_US_WEST_2
[Enum:
AWS_AP_NORTHEAST_1|AWS_AP_NORTHEAST_3|AWS_AP_SOUTH_1|AWS_AP_SOUTH_2|AWS_AP_SOUTHEAST_1|AWS_AP_SOUTHEAST_2|AWS_AP_SOUTHEAST_3|AWS_EU_CENTRAL_1|AWS_EU_NORTH_1|AWS_EU_WEST_1|AWS_ME_SOUTH_1|AWS_SA_EAST_1|AWS_US_EAST_1|AWS_US_EAST_2|AWS_US_WEST_1|AWS_US_WEST_2|GCP_ASIA_EAST_1|GCP_ASIA_EAST_2|GCP_ASIA_NORTHEAST_1|GCP_ASIA_NORTHEAST_2|GCP_ASIA_NORTHEAST_3|GCP_ASIA_SOUTH_1|GCP_ASIA_SOUTHEAST_1|GCP_ASIA_SOUTHEAST_2|GCP_AUSTRALIA_SOUTHEAST_1|GCP_EUROPE_WEST_1|GCP_EUROPE_WEST_2|GCP_EUROPE_WEST_3|GCP_NORTHAMERICA_NORTHEAST_1|GCP_NORTHAMERICA_NORTHEAST_2|GCP_SOUTHAMERICA_EAST_1|GCP_SOUTHAMERICA_WEST_1|GCP_US_CENTRAL_1|GCP_US_EAST_1|GCP_US_EAST_4|GCP_US_WEST_1|GCP_US_WEST_2]
Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3 AWS_EU_CENTRAL_1 AWS_EU_NORTH_1 AWS_EU_WEST_1 AWS_ME_SOUTH_1 AWS_SA_EAST_1 AWS_US_EAST_1 AWS_US_EAST_2 AWS_US_WEST_1 AWS_US_WEST_2 GCP_ASIA_EAST_1
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_bot_defense_app_infrastructure.example system/example