sub_​customer

Version: v2025-01-13Includes use: No

Behavior name: Subcustomer Enablement

When positioned in a property's top-level default rule, enables various Cloud Embed features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use the Akamai Cloud Embed API (ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also the dynamic_web_content behavior to configure subcustomers' dynamic web content.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "sub_customer" {
  rules_v2025_02_18 {
    name     = "Subcustomer Enablement"
    comments = "Enables various Cloud Embed features that allow you to leverage Akamai's CDN architecture for your own subcustomers."
    behavior {
      sub_customer {
        enabled                  = true
        origin                   = true
        partner_domain_suffix    = ""
        caching                  = true
        referrer                 = true
        ip                       = true
        geo_location             = true
        refresh_content          = true
        modify_path              = true
        cache_key                = true
        token_authorization      = true
        site_failover            = true
        content_compressor       = true
        access_control           = true
        dynamic_web_content      = false
        on_demand_video_delivery = false
        large_file_delivery      = false
      }
    }
  }
}
"behaviors": [
  {
    "name": "subCustomer",
    "options": {
      "enabled": true,
      "origin": true,
      "partnerDomainSuffix": "",
      "caching": true,
      "referrer": true,
      "ip": true,
      "geoLocation": true,
      "refreshContent": true,
      "modifyPath": true,
      "cacheKey": true,
      "tokenAuthorization": true,
      "siteFailover": true,
      "contentCompressor": true,
      "accessControl": true,
      "dynamicWebContent": false,
      "onDemandVideoDelivery": false,
      "largeFileDelivery": false
    }
  }
]

Options

Option Description
enabled
Allows Cloud Embed to dynamically modify your subcustomers' content.
origin
Allows you to assign origin hostnames for customers.
partner_domain_suffix
This specifies the appropriate domain suffix, which you should typically match with your property hostname. It identifies the domain as trustworthy on the Akamai network, despite being defined within Cloud Embed, outside of your base property configuration. Include this domain suffix if you want to purge subcustomer URLs. For example, if you provide a value of suffix.example.comthen to purge subcustomer.com/some/path specify subcustomer.com.suffix.example.com/some/path as the purge request's URL.
caching
Modifies content caching rules.
referrer
Sets subcustomers' referrer whitelists or blacklist.
ip
Sets subcustomers' IP whitelists or blacklists.
geo_location
Sets subcustomers' location-based whitelists or blacklists.
refresh_content
Allows you to reschedule when content validates for subcustomers.
modify_path
Modifies a subcustomer's request path.
cache_key
Allows you to set which query parameters are included in the cache key.
token_authorization
When enabled, this allows you to configure edge servers to use tokens to control access to subcustomer content. Use Cloud Embed to configure the token to appear in a cookie, header, or query parameter.
site_failover
Allows you to configure unique failover sites for each subcustomer's policy.
content_compressor
Allows compression of subcustomer content.
access_control
When enabled, this allows you to deny requests to a subcustomer's content based on specific match conditions, which you use Cloud Embed to configure in each subcustomer's policy.
dynamic_web_content
Allows you to apply the dynamic_web_content behavior to further modify how dynamic content behaves for subcustomers.
on_demand_video_delivery
Enables delivery of media assets to subcustomers.
large_file_delivery
Enables large file delivery for subcustomers.
web_application_firewall
Web application firewall (WAF) filters, monitors, and blocks certain HTTP traffic. Use Akamai Cloud Embed to add a specific behavior to a subcustomer policy and configure how WAF protection is applied.