Guide
Guide
  1. Property
  2. Data sources

Edge hostnames

📘

Beta

Hello. Just a note to let you know the underlying API on which this data source is built is general release and has been vetted, but because this is a new feature for our Terraform provider, we've given it beta label.

This status just means we've paused for a bit to get your feedback to make sure this data source works like you need and expect.

List all edge hostnames for your contract and group.

  • To assign any of the listed edge hostnames to a property, use the akamai_property resource.
  • To modify an existing edge hostname or delete any that aren't currently assigned to an active property configuration, use the akamai_edge_hostname resource.
data "akamai_edge_hostnames" "my-edge-hostnames" {
  contract_id = "C-0N7RAC7"
  group_id    = "12345"
}

output "my-edge-hostnames" {
  value = data.akamai_edge_hostnames.my-edge-hostnames
}
my-edge-hostnames = {
  account_id     = "act_A-CCT1234"
  contract_id    = "C-0N7RAC7"
  edge_hostnames = [
    {
      domain_prefix         = "example.com"
      domain_suffix         = "edgesuite.net"
      edge_hostname_domain  = "example.com.edgesuite.net"
      edge_hostname_id      = "ehn_98765"
      https_service_binding = null
      ip_version_behaviour  = "IPV4"
      product_id            = "prd_Download_Delivery"
      secure                = false
      status                = "CREATED"
      use_cases = [
        {
          option   = "BACKGROUND"
          type     = "GLOBAL"
          use_case = "Download_Mode"
        },
      ]
    },
    {
      domain_prefix         = "example-other.com"
      domain_suffix         = "edgekey.net"
      edge_hostname_domain  = "example-other.com.edgekey.net"
      edge_hostname_id      = "ehn_54321"
      https_service_binding = null
      ip_version_behaviour  = "IPV4"
      product_id            = "prd_Adaptive_Media_Delivery"
      secure                = true
      status                = "CREATED"
      use_cases = [
        {
          option   = "VOD"
          type     = "GLOBAL"
          use_case = "Segmented_Media_Mode"
        },
      ]
    },
  ]
  group_id       = "12345"
  options        = null
}

Arguments

Pass your contract and group IDs in the data block to get all edge hostnames.

NameRequiredDescription
contract_id✔Your contract's ID.
group_id✔Your group's ID.
optionsOptional query parameters that enable extra mapping-related information. Currently, the only supported option is mapDetails.

Attributes

Returned to you is the account and a set of edge hostnames.

Name Description
account_id The account's ID.
edge_hostnames The set of requested edge hostnames.
  • domain_prefix. The origin domain portion of the edge hostname.
    An edge hostname consists of a customer-specific domain_prefix such as example.com and an Akamai-specific domain_suffix such as edgesuite.net. The edge hostname's final DNS CNAME combines the two, for example, example.com.edgesuite.net.
  • domain_suffix. The Akamai-specific portion of the edge hostname, for example, edgesuite.net.
  • edge_hostname_domain. The full edge domain name formed from the domain_prefix and domain_suffix.
  • edge_hostname_id. The edge hostname's ID, which can be assigned to a property.
  • ip_version_behaviour. The IP version behavior of the edge hostname.
  • product_id. The product ID for which you created the edge hostname.
  • secure. Whether to use the edge hostname with SSL. Defaults to false for POST requests. Enabling this option for new edge hostnames isn't supported.
  • status. The status of the edge hostname. Possible values are:
    • PENDING indicates any newly defined hostname whose DNS mapping hasn't yet been distributed across the entire Akamai network.
    • CREATED indicates the DNS mapping distribution has completed.
    If the status is omitted, it indicates the edge hostname is active. Note that an edge hostname's status isn't related to a property activation's deployment status.
  • https_service_binding. The type of HTTPS service binding for the edge hostname. Possible values are: H2, H3, or H2_AND_H3. May be null if it wasn't specified upon edge hostname creation.
  • use_cases. Available use cases for edge hostnames assigned to the product. May be null if no use cases were specified upon edge hostname creation.
    • option. One of the options available in the response.
    • type. The type of the network over which traffic deploys. Currently, the only available value is GLOBAL.
    • use_case. The name of the use case.

Updated 14 days ago