f5xc_apm Resource - terraform-provider-f5xc

f5xc_apm (Resource)

Manages new APM as a service with configured parameters. in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# APM Resource Example
# Manages new APM as a service with configured parameters. in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic APM configuration
resource "f5xc_apm" "example" {
  name      = "example-apm"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Resource-specific configuration
  # [OneOf: aws_site_type_choice, baremetal_site_type_choice]...
  aws_site_type_choice {
    # Configure aws_site_type_choice settings
  }
  # Virtual F5 BIG-IP configuration for AWS TGW Site using BI...
  apm_aws_site {
    # Configure apm_aws_site settings
  }
  # SecretType is used in an object to indicate a sensitive/c...
  admin_password {
    # Configure admin_password settings
  }
}

Argument Reference

🔶 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 APM. Must be unique within the namespace

• namespace - Required String
Namespace where the APM 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

-> One of the following: • aws_site_type_choice - Optional Block
Virtual F5 BIG-IP APM service to be deployed as external service on AWS Transit Gateway Site
See AWS Site Type Choice below for details.

• baremetal_site_type_choice - Optional Block
Virtual BIG-IP specification for App Stack Bare Metal Site
See Baremetal Site Type Choice below for details.

• https_management - Optional Block
Configuration parameter for HTTPS management
See HTTPS Management below for details.

• timeouts - Optional Block

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

AWS Site Type Choice

An aws_site_type_choice block supports the following:

• apm_aws_site - Optional Block
Virtual F5 BIG-IP configuration for AWS TGW Site using BIG-IP APM service
See APM AWS Site below.

• market_place_image - Optional Block
Select the flavor of BIG-IP AWS Marketplace to launch the instance on AWS TGW Site
See Market Place Image below.

AWS Site Type Choice APM AWS Site

An apm_aws_site block (within aws_site_type_choice) supports the following:

• admin_password - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Admin Password below.

• admin_username - Optional String
Admin Username for BIG-IP

• aws_tgw_site - Optional Block
BIG-IP AWS TGW Site. BIG-IP AWS TGW site specification
See AWS TGW Site below.

• endpoint_service - Optional Block
Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new destination address
See Endpoint Service below.

• nodes - Optional Block
Specify how and where the service nodes are spawned
See Nodes below.

• ssh_key - Optional String
Public SSH key for accessing the BIG-IP nodes

• tags - Optional Block
AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console

AWS Site Type Choice APM AWS Site Admin Password

Deeply nested Password block collapsed for readability.

AWS Site Type Choice APM AWS Site Admin Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

AWS Site Type Choice APM AWS Site Admin Password Clear Secret Info

Deeply nested Info block collapsed for readability.

AWS Site Type Choice APM AWS Site AWS TGW Site

Deeply nested Site block collapsed for readability.

AWS Site Type Choice APM AWS Site AWS TGW Site AWS TGW Site

Deeply nested Site block collapsed for readability.

AWS Site Type Choice APM AWS Site Endpoint Service

Deeply nested Service block collapsed for readability.

AWS Site Type Choice APM AWS Site Endpoint Service Custom TCP Ports

Deeply nested Ports block collapsed for readability.

AWS Site Type Choice APM AWS Site Endpoint Service Custom UDP Ports

Deeply nested Ports block collapsed for readability.

AWS Site Type Choice APM AWS Site Nodes

Deeply nested Nodes block collapsed for readability.

AWS Site Type Choice APM AWS Site Nodes Mgmt Subnet

Deeply nested Subnet block collapsed for readability.

AWS Site Type Choice APM AWS Site Nodes Mgmt Subnet Subnet Param

Deeply nested Param block collapsed for readability.

AWS Site Type Choice Market Place Image

A market_place_image block (within aws_site_type_choice) supports the following:

• best_plus_pay_g200_mbps - Optional Block
Configuration parameter for BestPlusPayG200Mbps

• best_plus_payg_1gbps - Optional Block
Configuration parameter for best plus payg 1gbps

Baremetal Site Type Choice

A baremetal_site_type_choice block supports the following:

• f5_bare_metal_site - Optional Block
Virtual BIG-IP specification for App Stack bare metal
See F5 Bare Metal Site below.

Baremetal Site Type Choice F5 Bare Metal Site

Deeply nested Site block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Admin Password

Deeply nested Password block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Admin Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Admin Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Bare Metal Site

Deeply nested Site block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Bigiq Instance

Deeply nested Instance block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Bigiq Instance Password

Deeply nested Password block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Bigiq Instance Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Bigiq Instance Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Nodes

Deeply nested Nodes block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Nodes External Interface

Deeply nested Interface block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Nodes External Interface Interface

Deeply nested Interface block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Nodes Internal Interface

Deeply nested Interface block collapsed for readability.

Baremetal Site Type Choice F5 Bare Metal Site Nodes Internal Interface Interface

Deeply nested Interface block collapsed for readability.

HTTPS Management

A https_management block supports the following:

• advertise_on_internet - Optional Block
Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available
See Advertise On internet below.

• advertise_on_internet_default_vip - Optional Block
Enable this option

• advertise_on_sli_vip - Optional Block
Inline TLS Parameters. Inline TLS parameters
See Advertise On SLI VIP below.

• advertise_on_slo_internet_vip - Optional Block
Inline TLS Parameters. Inline TLS parameters
See Advertise On Slo internet VIP below.

• advertise_on_slo_sli - Optional Block
Configuration parameter for advertise on slo SLI
See Advertise On Slo SLI below.

• advertise_on_slo_vip - Optional Block
Inline TLS Parameters. Inline TLS parameters
See Advertise On Slo VIP below.

• default_https_port - Optional Block
Enable this option

• domain_suffix - Optional String
Domain suffix will be used along with node name to form URL to access node management

• https_port - Optional Number
Enter TCP port number

HTTPS Management Advertise On internet

An advertise_on_internet block (within https_management) supports the following:

• public_ip - 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 Public IP below.

HTTPS Management Advertise On internet Public IP

A public_ip block (within https_management.advertise_on_internet) 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

HTTPS Management Advertise On SLI VIP

An advertise_on_sli_vip block (within https_management) supports the following:

• no_mtls - Optional Block
Enable this option

• tls_certificates - Optional Block
Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms
See TLS Certificates below.

• tls_config - Optional Block
Defines various OPTIONS to configure TLS configuration parameters
See TLS Config below.

• use_mtls - Optional Block
Validation context for downstream client TLS connections
See Use mTLS below.

HTTPS Management Advertise On SLI VIP TLS Certificates

Deeply nested Certificates block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Config

Deeply nested Config block collapsed for readability.

HTTPS Management Advertise On SLI VIP TLS Config Custom Security

Deeply nested Security block collapsed for readability.

HTTPS Management Advertise On SLI VIP Use mTLS

Deeply nested mTLS block collapsed for readability.

HTTPS Management Advertise On SLI VIP Use mTLS CRL

Deeply nested CRL block collapsed for readability.

HTTPS Management Advertise On SLI VIP Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

HTTPS Management Advertise On SLI VIP Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP

An advertise_on_slo_internet_vip block (within https_management) supports the following:

• no_mtls - Optional Block
Enable this option

• tls_certificates - Optional Block
Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms
See TLS Certificates below.

• tls_config - Optional Block
Defines various OPTIONS to configure TLS configuration parameters
See TLS Config below.

• use_mtls - Optional Block
Validation context for downstream client TLS connections
See Use mTLS below.

HTTPS Management Advertise On Slo internet VIP TLS Certificates

Deeply nested Certificates block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Config

Deeply nested Config block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP TLS Config Custom Security

Deeply nested Security block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP Use mTLS

Deeply nested mTLS block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP Use mTLS CRL

Deeply nested CRL block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

HTTPS Management Advertise On Slo internet VIP Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

HTTPS Management Advertise On Slo SLI

An advertise_on_slo_sli block (within https_management) supports the following:

• no_mtls - Optional Block
Enable this option

• tls_certificates - Optional Block
Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms
See TLS Certificates below.

• tls_config - Optional Block
Defines various OPTIONS to configure TLS configuration parameters
See TLS Config below.

• use_mtls - Optional Block
Validation context for downstream client TLS connections
See Use mTLS below.

HTTPS Management Advertise On Slo SLI TLS Certificates

Deeply nested Certificates block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Config

Deeply nested Config block collapsed for readability.

HTTPS Management Advertise On Slo SLI TLS Config Custom Security

Deeply nested Security block collapsed for readability.

HTTPS Management Advertise On Slo SLI Use mTLS

Deeply nested mTLS block collapsed for readability.

HTTPS Management Advertise On Slo SLI Use mTLS CRL

Deeply nested CRL block collapsed for readability.

HTTPS Management Advertise On Slo SLI Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

HTTPS Management Advertise On Slo SLI Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

HTTPS Management Advertise On Slo VIP

An advertise_on_slo_vip block (within https_management) supports the following:

• no_mtls - Optional Block
Enable this option

• tls_certificates - Optional Block
Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms
See TLS Certificates below.

• tls_config - Optional Block
Defines various OPTIONS to configure TLS configuration parameters
See TLS Config below.

• use_mtls - Optional Block
Validation context for downstream client TLS connections
See Use mTLS below.

HTTPS Management Advertise On Slo VIP TLS Certificates

Deeply nested Certificates block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Config

Deeply nested Config block collapsed for readability.

HTTPS Management Advertise On Slo VIP TLS Config Custom Security

Deeply nested Security block collapsed for readability.

HTTPS Management Advertise On Slo VIP Use mTLS

Deeply nested mTLS block collapsed for readability.

HTTPS Management Advertise On Slo VIP Use mTLS CRL

Deeply nested CRL block collapsed for readability.

HTTPS Management Advertise On Slo VIP Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

HTTPS Management Advertise On Slo VIP Use mTLS Xfcc Options

Deeply nested Options 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 f5xc_apm.example system/example