Skip to content

xcsh_bot_defense_app_infrastructure (Data Source)

Retrieves information about Bot Defense App Infrastructure in a given namespace in F5 Distributed Cloud. This is a read-only data source.

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

# BotDefenseAppInfrastructure Data Source Example
terraform {
required_version = ">= 1.0"
required_providers {
xcsh = {
source = "f5-sales-demo/xcsh"
version = ">= 0.1.0"
}
}
}
# Look up an existing BotDefenseAppInfrastructure by name
data "xcsh_bot_defense_app_infrastructure" "example" {
name = "example-bot-defense-app-infrastructure"
namespace = "staging"
}
output "bot_defense_app_infrastructure_id" {
value = data.xcsh_bot_defense_app_infrastructure.example.id
}

-> 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.

• name - Required String
Name of the BotDefenseAppInfrastructure

• namespace - Required String
Namespace where the BotDefenseAppInfrastructure exists

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

• annotations - Optional Map
Annotations applied to this resource

• cloud_hosted - Optional String
F5 Hosted. Infra F5 Hosted

• data_center_hosted - Optional String
F5 Hosted. Infra F5 Hosted

• description - Optional String
Description of the BotDefenseAppInfrastructure

• environment_type - Optional String Defaults to PRODUCTION
Possible values are PRODUCTION, TESTING
[Enum: PRODUCTION|TESTING] Environment Type Production environment Testing environment

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• traffic_type - Optional String Defaults to WEB
Possible values are WEB, MOBILE
[Enum: WEB|MOBILE] Traffic Type Web traffic Mobile traffic

• egress - Optional List
Egress. Egress

• infra_host_name - Optional String
Infra hostname. Infra hostname

• ingress - Optional List
Ingress. Ingress

• 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

• 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

• 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

• egress - Optional List
Egress. Egress

• infra_host_name - Optional String
Infra hostname. Infra hostname

• ingress - Optional List
Ingress. Ingress

• 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

• 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

• 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


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