xcsh_alert_receiver (Data Source)

Retrieves information about new Alert 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

# AlertReceiver Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing AlertReceiver by name
data "xcsh_alert_receiver" "example" {
  name      = "example-alert-receiver"
  namespace = "staging"
}

output "alert_receiver_id" {
  value = data.xcsh_alert_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
• receiver_choice

Example (API format):

metadata:
  name: my-alert-receiver
  namespace: demo-app
spec:
  email:
    email_address: alerts@example.com

Metadata Argument Reference

• name - Required String
Name of the AlertReceiver

• namespace - Required String
Namespace where the AlertReceiver exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the AlertReceiver

• email - Optional String
Email Configuration

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• opsgenie - Optional String
OpsGenie configuration to send alert notifications

• pagerduty - Optional String
PagerDuty configuration to send alert notifications

• slack - Optional String
Slack configuration to send alert notifications

• sms - Optional String
SMS Configuration

• webhook - Optional String
Webhook configuration to send alert notifications

---

Email

An email block supports the following:

• email - Optional String
Email. Email ID of the user

Opsgenie

An opsgenie block supports the following:

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

• url - Optional String
API URL. URL to send API requests to

Opsgenie API Key

An api_key block (within opsgenie) supports the following:

• 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

Opsgenie API Key Blindfold Secret Info

A blindfold_secret_info block (within opsgenie.api_key) supports the following:

• 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:///

Opsgenie API Key Clear Secret Info

A clear_secret_info block (within opsgenie.api_key) supports the following:

• 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

Pagerduty

A pagerduty block supports the following:

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

• url - Optional String
Pager Duty URL. URL to send API requests to

Pagerduty Routing Key

A routing_key block (within pagerduty) supports the following:

• 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

Pagerduty Routing Key Blindfold Secret Info

A blindfold_secret_info block (within pagerduty.routing_key) supports the following:

• 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:///

Pagerduty Routing Key Clear Secret Info

A clear_secret_info block (within pagerduty.routing_key) supports the following:

• 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

Slack

A slack block supports the following:

• channel - Optional String
Channel or user to send notifications to

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

Slack URL

An url block (within slack) supports the following:

• 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

Slack URL Blindfold Secret Info

A blindfold_secret_info block (within slack.url) supports the following:

• 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:///

Slack URL Clear Secret Info

A clear_secret_info block (within slack.url) supports the following:

• 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

Sms

A sms block supports the following:

• contact_number - Optional String
Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code]

Webhook

A webhook block supports the following:

• http_config - Optional String
HTTP Configuration. Configuration for HTTP endpoint

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

Webhook HTTP Config

A http_config block (within webhook) supports the following:

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

• basic_auth - Optional String
Authorization parameters to access HTPP alert Receiver Endpoint

• client_cert_obj - Optional String
Client Certificate Object. Configuration for client certificate

• enable_http2 - Optional Bool
Enable HTTP2. Configure to use HTTP2 protocol

• follow_redirects - Optional Bool
Configure whether HTTP requests follow HTTP 3xx redirects

• no_authorization - Optional Object
Configuration parameter for no authorization

• no_tls - Optional Object
Enable this option

• use_tls - Optional String
Configures the token request’s TLS settings

Webhook HTTP Config Auth Token

An auth_token block (within webhook.http_config) supports the following:

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

Webhook HTTP Config Auth Token Token

A token block (within webhook.http_config.auth_token) supports the following:

• 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

Webhook HTTP Config Auth Token Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Webhook HTTP Config Auth Token Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Webhook HTTP Config Basic Auth

A basic_auth block (within webhook.http_config) supports the following:

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

• user_name - Optional String
username. HTTP Basic Auth username

Webhook HTTP Config Basic Auth Password

A password block (within webhook.http_config.basic_auth) supports the following:

• 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

Webhook HTTP Config Basic Auth Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Webhook HTTP Config Basic Auth Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Webhook HTTP Config Client Cert Obj

A client_cert_obj block (within webhook.http_config) supports the following:

• use_tls_obj - Optional List
Certificate Object. Reference to client certificate object

Webhook HTTP Config Client Cert Obj Use TLS Obj

Deeply nested Obj block collapsed for readability.

Webhook HTTP Config No Authorization

A no_authorization block (within webhook.http_config) supports the following:

Webhook HTTP Config No TLS

A no_tls block (within webhook.http_config) supports the following:

Webhook HTTP Config Use TLS

An use_tls block (within webhook.http_config) supports the following:

• disable_sni - Optional Object
Configuration parameter for disable sni

• max_version - Optional String Defaults to TLS_AUTO
Possible values are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3
[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version

• min_version - Optional String Defaults to TLS_AUTO
Possible values are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3
[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version

• sni - Optional String
SNI value to be used

• use_server_verification - Optional String
Configuration parameter for use server verification

• volterra_trusted_ca - Optional Object
Configuration parameter for volterra trusted CA

Webhook HTTP Config Use TLS Disable Sni

A disable_sni block (within webhook.http_config.use_tls) supports the following:

Webhook HTTP Config Use TLS Use Server Verification

Deeply nested Verification block collapsed for readability.

Webhook HTTP Config Use TLS Use Server Verification CA Cert Obj

Deeply nested Obj block collapsed for readability.

Webhook HTTP Config Use TLS Use Server Verification CA Cert Obj Trusted CA

Deeply nested CA block collapsed for readability.

Webhook HTTP Config Use TLS Volterra Trusted CA

Deeply nested CA block collapsed for readability.

Webhook URL

An url block (within webhook) supports the following:

• 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

Webhook URL Blindfold Secret Info

A blindfold_secret_info block (within webhook.url) supports the following:

• 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:///

Webhook URL Clear Secret Info

A clear_secret_info block (within webhook.url) supports the following:

• 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