xcsh_global_log_receiver (Data Source)

Retrieves information about new Global Log Receiver object in F5 Distributed Cloud. This is a read-only data source.

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

Example Usage

# GlobalLogReceiver Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing GlobalLogReceiver by name
data "xcsh_global_log_receiver" "example" {
  name      = "example-global-log-receiver"
  namespace = "staging"
}

output "global_log_receiver_id" {
  value = data.xcsh_global_log_receiver.example.id
}

Argument Reference

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

Minimum Configuration

Required fields:

• name
• namespace
• log_type
• receiver_choice

Example (API format):

metadata:
  name: my-log-receiver
  namespace: demo-app
spec:
  request_logs: {}
  http_receiver:
    uri: `http://logs.example.com/ingest`

Metadata Argument Reference

• name - Required String
Name of the GlobalLogReceiver

• namespace - Required String
Namespace where the GlobalLogReceiver exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• audit_logs - Optional Object
Enable this option

• aws_cloud_watch_receiver - Optional String
AWS Cloudwatch Logs Configuration for Global Log Receiver

• azure_event_hubs_receiver - Optional String
Azure Event Hubs Configuration for Global Log Receiver

• azure_receiver - Optional String
Azure Blob Configuration for Global Log Receiver

• datadog_receiver - Optional String
Datadog Configuration. Configuration for Datadog endpoint

• description - Optional String
Description of the GlobalLogReceiver

• dns_logs - Optional Object
Enable this option

• gcp_bucket_receiver - Optional String
GCP Bucket Configuration for Global Log Receiver

• http_receiver - Optional String
Configuration parameter for HTTP receiver

• id - Optional String
Unique identifier for the resource

• kafka_receiver - Optional String
Kafka Configuration for Global Log Receiver

• labels - Optional Map
Labels applied to this resource

• new_relic_receiver - Optional String
Configuration parameter for new relic receiver

• ns_all - Optional Object
Enable this option

• ns_current - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• ns_list - Optional String
Namespace List. Namespace List

• qradar_receiver - Optional String
Configuration parameter for qradar receiver

• request_logs - Optional String
Configuration for request logs with sampling choice. Allows selection between sampled (default) or unsampled (full) request logs

• s3_receiver - Optional String
S3 Configuration for Global Log Receiver

• security_events - Optional Object
Enable this option

• splunk_receiver - Optional String
Configuration for Splunk HEC Logs endpoint

• sumo_logic_receiver - Optional String
Configuration parameter for sumo logic receiver

• aws_cred - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• aws_region - Optional String
Possible values are ap-northeast-1, ap-southeast-1, eu-central-1, eu-west-1, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-2, CA-central-1, af-south-1, ap-east-1, ap-south-1, ap-northeast-2, ap-southeast-2, eu-south-1, eu-north-1, eu-west-2, me-south-1, us-west-1, ap-southeast-3
[Enum: ap-northeast-1|ap-southeast-1|eu-central-1|eu-west-1|eu-west-3|sa-east-1|us-east-1|us-east-2|us-west-2|CA-central-1|af-south-1|ap-east-1|ap-south-1|ap-northeast-2|ap-southeast-2|eu-south-1|eu-north-1|eu-west-2|me-south-1|us-west-1|ap-southeast-3] AWS Region. AWS Region Name

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• group_name - Optional String
The group name of the target Cloudwatch Logs stream

• stream_name - Optional String
The stream name of the target Cloudwatch Logs stream. Note that there can only be one writer to a log stream at a time

• 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

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• connection_string - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• instance - Optional String
Event Hubs Instance name into which logs should be stored

• namespace - Optional String
Event Hubs Namespace is namespace with instance into which logs should be stored

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• connection_string - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• container_name - Optional String
Container Name is the name of the container into which logs should be stored

• filename_options - Optional String
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• datadog_api_key - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• endpoint - Optional String
Datadog Endpoint,

• no_tls - Optional Object
Enable this option

• site - Optional String
Datadog Site,

• use_tls - Optional String
TLS Parameters for client connection to the endpoint

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional String
mTLS Client config allows configuration of mTLS client OPTIONS

• no_ca - Optional Object
Enable this option

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• bucket - Optional String
GCP Bucket Name. GCP Bucket Name

• compression - Optional String
Configuration parameter for compression

• filename_options - Optional String
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file

• gcp_cred - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

• 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

• auth_basic - Optional String
Authentication parameters to access HTPP Log Receiver Endpoint

• auth_none - Optional Object
Enable this option

• auth_token - Optional String
Access Token. Authentication Token for access

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• no_tls - Optional Object
Enable this option

• uri - Optional String
HTTP URI is the URI of the HTTP endpoint to send logs to,

• use_tls - Optional String
TLS Parameters for client connection to the endpoint

• password - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• user_name - Optional String
username. HTTP Basic Auth username

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• token - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional String
mTLS Client config allows configuration of mTLS client OPTIONS

• no_ca - Optional Object
Enable this option

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• bootstrap_servers - Optional List
List of host:port pairs of the Kafka brokers

• compression - Optional String
Configuration parameter for compression

• kafka_topic - Optional String
The Kafka topic name to write events to

• no_tls - Optional Object
Enable this option

• use_tls - Optional String
TLS Parameters for client connection to the endpoint

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional String
mTLS Client config allows configuration of mTLS client OPTIONS

• no_ca - Optional Object
Enable this option

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• api_key - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• eu - Optional Object
Enable this option

• us - Optional Object
Enable this option

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• namespaces - Optional List
Namespaces. List of namespaces to stream logs for

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• no_tls - Optional Object
Enable this option

• uri - Optional String
Log Source Collector URL is the URL of the IBM QRadar Log Source Collector to send logs to,

• use_tls - Optional String
TLS Parameters for client connection to the endpoint

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional String
mTLS Client config allows configuration of mTLS client OPTIONS

• no_ca - Optional Object
Enable this option

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• sampled - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• unsampled - Optional Object
Enable this option

• aws_cred - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• aws_region - Optional String
Possible values are ap-northeast-1, ap-southeast-1, eu-central-1, eu-west-1, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-2, CA-central-1, af-south-1, ap-east-1, ap-south-1, ap-northeast-2, ap-southeast-2, eu-south-1, eu-north-1, eu-west-2, me-south-1, us-west-1, ap-southeast-3
[Enum: ap-northeast-1|ap-southeast-1|eu-central-1|eu-west-1|eu-west-3|sa-east-1|us-east-1|us-east-2|us-west-2|CA-central-1|af-south-1|ap-east-1|ap-south-1|ap-northeast-2|ap-southeast-2|eu-south-1|eu-north-1|eu-west-2|me-south-1|us-west-1|ap-southeast-3] AWS Region. AWS Region Name

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• bucket - Optional String
S3 Bucket Name. S3 Bucket Name

• compression - Optional String
Configuration parameter for compression

• filename_options - Optional String
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file

• 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

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

• batch - Optional String
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint

• compression - Optional String
Configuration parameter for compression

• endpoint - Optional String
Splunk HEC Logs Endpoint. Splunk HEC Logs Endpoint, (Note: must not contain /services/collector)

• no_tls - Optional Object
Enable this option

• splunk_hec_token - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• use_tls - Optional String
TLS Parameters for client connection to the endpoint

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional String
mTLS Client config allows configuration of mTLS client OPTIONS

• no_ca - Optional Object
Enable this option

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• url - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

---

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