- Home
- Documentation
- resources
- f5xc_cloud_connect Resource - terraform-provider-f5xc
f5xc_cloud_connect Resource - terraform-provider-f5xc
f5xc_cloud_connect (Resource)
Section titled “f5xc_cloud_connect (Resource)”Manages a Cloud Connect resource in F5 Distributed Cloud for establishing connectivity to cloud provider networks.
~> Note For more information about this resource, please refer to the F5 XC API Documentation.
Example Usage
Section titled “Example Usage”# Cloud Connect Resource Example# Manages a Cloud Connect resource in F5 Distributed Cloud for establishing connectivity to cloud provider networks.
terraform { required_version = ">= 1.0"
required_providers { f5xc = { source = "f5xc-salesdemos/f5xc" version = ">= 0.1.0" } }}
# Basic Cloud Connect configurationresource "f5xc_cloud_connect" "example" { name = "example-cloud-connect" namespace = "staging"
labels = { environment = "production" managed_by = "terraform" }
annotations = { "owner" = "platform-team" }
# Resource-specific configuration # Configuration parameter for aws provider. aws_provider { # Configure aws_provider settings } # AWS TGW Site Type. Cloud Connect AWS TGW Site Type. aws_tgw_site { # Configure aws_tgw_site settings } # Type establishes a direct reference from one object(the r... cred { # Configure cred 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 Cloud Connect. Must be unique within the namespace
• namespace - Required String
Namespace where the Cloud Connect 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”• aws_provider - Optional Block
Configuration parameter for AWS provider
See AWS Provider below for details.
-> One of the following:
• aws_tgw_site - Optional Block
AWS TGW Site Type. Cloud Connect AWS TGW Site Type
See AWS TGW Site below for details.
• azure_vnet_site - Optional Block
Azure VNET Site Type. Cloud Connect Azure VNET Site Type
See Azure VNET Site below for details.
• segment - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Segment 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
AWS Provider
Section titled “AWS Provider”An aws_provider block supports the following:
• aws_tgw_site - Optional Block
AWS TGW Site Type. Cloud Connect AWS TGW Site Type
See AWS TGW Site below.
AWS Provider AWS TGW Site
Section titled “AWS Provider AWS TGW Site”An aws_tgw_site block (within aws_provider) supports the following:
• cred - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Cred below.
• site - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Site below.
• vpc_attachments - Optional Block
Configuration parameter for VPC attachments
See VPC Attachments below.
AWS Provider AWS TGW Site Cred
Section titled “AWS Provider AWS TGW Site Cred”A cred block (within aws_provider.aws_tgw_site) 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
• 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
AWS Provider AWS TGW Site Site
Section titled “AWS Provider AWS TGW Site Site”A site block (within aws_provider.aws_tgw_site) 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
• 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
AWS Provider AWS TGW Site VPC Attachments
Section titled “AWS Provider AWS TGW Site VPC Attachments”A vpc_attachments block (within aws_provider.aws_tgw_site) supports the following:
• vpc_list - Optional Block
VPC List. Collection of items or values
See VPC List below.
AWS Provider AWS TGW Site VPC Attachments VPC List
Section titled “AWS Provider AWS TGW Site VPC Attachments VPC List”Deeply nested List block collapsed for readability.
AWS Provider AWS TGW Site VPC Attachments VPC List Custom Routing
Section titled “AWS Provider AWS TGW Site VPC Attachments VPC List Custom Routing”Deeply nested Routing block collapsed for readability.
AWS Provider AWS TGW Site VPC Attachments VPC List Custom Routing Route Tables
Section titled “AWS Provider AWS TGW Site VPC Attachments VPC List Custom Routing Route Tables”Deeply nested Tables block collapsed for readability.
AWS Provider AWS TGW Site VPC Attachments VPC List Default Route
Section titled “AWS Provider AWS TGW Site VPC Attachments VPC List Default Route”Deeply nested Route block collapsed for readability.
AWS Provider AWS TGW Site VPC Attachments VPC List Default Route Selective Route Tables
Section titled “AWS Provider AWS TGW Site VPC Attachments VPC List Default Route Selective Route Tables”Deeply nested Tables block collapsed for readability.
AWS TGW Site
Section titled “AWS TGW Site”An aws_tgw_site block supports the following:
• cred - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Cred below.
• site - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Site below.
• vpc_attachments - Optional Block
Configuration parameter for VPC attachments
See VPC Attachments below.
AWS TGW Site Cred
Section titled “AWS TGW Site Cred”A cred block (within aws_tgw_site) 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
• 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
AWS TGW Site Site
Section titled “AWS TGW Site Site”A site block (within aws_tgw_site) 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
• 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
AWS TGW Site VPC Attachments
Section titled “AWS TGW Site VPC Attachments”A vpc_attachments block (within aws_tgw_site) supports the following:
• vpc_list - Optional Block
VPC List. Collection of items or values
See VPC List below.
AWS TGW Site VPC Attachments VPC List
Section titled “AWS TGW Site VPC Attachments VPC List”A vpc_list block (within aws_tgw_site.vpc_attachments) supports the following:
• custom_routing - Optional Block
AWS Route Table List. AWS Route Table List
See Custom Routing below.
• default_route - Optional Block
Configuration parameter for default route
See Default Route below.
• labels - Optional Block
Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall
• manual_routing - Optional Block
Enable this option
• vpc_id - Optional String
Enter the VPC ID of the VPC to be attached
AWS TGW Site VPC Attachments VPC List Custom Routing
Section titled “AWS TGW Site VPC Attachments VPC List Custom Routing”Deeply nested Routing block collapsed for readability.
AWS TGW Site VPC Attachments VPC List Custom Routing Route Tables
Section titled “AWS TGW Site VPC Attachments VPC List Custom Routing Route Tables”Deeply nested Tables block collapsed for readability.
AWS TGW Site VPC Attachments VPC List Default Route
Section titled “AWS TGW Site VPC Attachments VPC List Default Route”Deeply nested Route block collapsed for readability.
AWS TGW Site VPC Attachments VPC List Default Route Selective Route Tables
Section titled “AWS TGW Site VPC Attachments VPC List Default Route Selective Route Tables”Deeply nested Tables block collapsed for readability.
Azure VNET Site
Section titled “Azure VNET Site”An azure_vnet_site block supports the following:
• site - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Site below.
• vnet_attachments - Optional Block
Configuration parameter for VNET attachments
See VNET Attachments below.
Azure VNET Site Site
Section titled “Azure VNET Site Site”A site block (within azure_vnet_site) 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
• 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
Azure VNET Site VNET Attachments
Section titled “Azure VNET Site VNET Attachments”A vnet_attachments block (within azure_vnet_site) supports the following:
• vnet_list - Optional Block
VNET List. Collection of items or values
See VNET List below.
Azure VNET Site VNET Attachments VNET List
Section titled “Azure VNET Site VNET Attachments VNET List”A vnet_list block (within azure_vnet_site.vnet_attachments) supports the following:
• custom_routing - Optional Block
List Azure Route Table with Static Route
See Custom Routing below.
• default_route - Optional Block
Configuration parameter for default route
See Default Route below.
• labels - Optional Block
Add labels for the VNET attachments. These labels can then be used in policies such as enhanced firewall policies
• manual_routing - Optional Block
Enable this option
• subscription_id - Optional String
Enter the Subscription ID of the VNET to be attached
• vnet_id - Optional String
Enter the VNET ID of the VNET to be attached in format /<resource-group-name>/<VNET-name>
Azure VNET Site VNET Attachments VNET List Custom Routing
Section titled “Azure VNET Site VNET Attachments VNET List Custom Routing”Deeply nested Routing block collapsed for readability.
Azure VNET Site VNET Attachments VNET List Custom Routing Route Tables
Section titled “Azure VNET Site VNET Attachments VNET List Custom Routing Route Tables”Deeply nested Tables block collapsed for readability.
Azure VNET Site VNET Attachments VNET List Default Route
Section titled “Azure VNET Site VNET Attachments VNET List Default Route”Deeply nested Route block collapsed for readability.
Azure VNET Site VNET Attachments VNET List Default Route Selective Route Tables
Section titled “Azure VNET Site VNET Attachments VNET List Default Route Selective Route Tables”Deeply nested Tables block collapsed for readability.
Segment
Section titled “Segment”A segment block 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
• 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
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_cloud_connect.example system/example