Skip to content

f5xc_cloud_connect Resource - terraform-provider-f5xc

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.

# 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 configuration
resource "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
}
}

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

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

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.

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

id - Optional String
Unique identifier for the resource


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.

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.

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

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

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.

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.

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

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

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.

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.

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.

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

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.

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

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