Domain

akamai_gtm_domain

 Average processing time 5–10 minutes

Create, update, or delete a GTM domain, which is a basic building block of a traffic management configuration. To delete a domain, run terraform destroy.

resource "akamai_gtm_domain" "my-domain" {
  contract                = "C-0N7RAC7"
  group                   = 12345
  name                    = "example.akadns.net"
  type                    = "basic"
  email_notification_list = ["jsmith@email.com"]
  comment                 = "Sample comment"
}

Arguments

Pass a name and type of a domain to create the record. Provide additional arguments to better customize your domain.

Argument Required Description
name ✔️ The full GTM domain's name. It needs to end in .akadns.net and can have up to 100 characters.
type ✔️ Th type of GTM domain. Possible values:
  • failover-only
  • static
  • weighted
  • basic
  • full
contract Your contract's ID.
group Your group's ID.
comment A descriptive note about changes to the domain. The maximum is 4000 characters.
email_notification_list Email addresses to notify when a change is made to the domain.
wait_on_complete When set to true, this waits for transaction to complete.
default_timeout_penalty The timeout penalty score. Default is 25.
load_imbalance_percentage The percentage of load imbalance factor (LIF) for the domain.
default_ssl_client_certificate An optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS).
default_ssl_client_private_key An optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS).
default_error_penalty The download penalty score. The default is 75. If the download encounters an error, the web agent computes a score that is either the download time in seconds or a penalty score.
cname_coalescing_enabled When set to true, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME.
load_feedback When set to true, one or more measurements of load (resources) are defined by you and supplied by each data center in real-time to balance load.
end_user_mapping_enabled When set to true, the GTM domain is using end-user client subnet mapping.
sign_and_serve When set to true, the domain's resource record is signed for validation by a validating resolver.
sign_and_serve_algorithm The signing algorithm used for sign_and_serve. Value is one of:
  • RSA_SHA1
  • RSA_SHA256
  • RSA_SHA512
  • ECDSA_P256_SHA256
  • ECDSA_P384_SHA384
  • ED25519
  • ED448

Attributes

There is no default standard output. Upon creation, the last line of the process log contains a success message with your domain's ID.

Adding an output block returns the domain details you provided on create along with the computed attributes.

Attribute Description
id The resource's ID, same as the GTM domain's name.
default_unreachable_threshold The penalty value added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value.
min_pingable_region_fraction The minimum ping fraction score for data centers. If set, any core point that cannot ping more than this fraction of data centers is rejected and not mapped by ping scores.
servermonitor_liveness_count The number of successful health checks required for an origin server or endpoint to be considered healthy.
servermonitor_load_count The number of parallel health checks that a server monitor performs during each health assessment.
servermonitor_pool The name of the server monitor group responsible for assessing the health of your origin servers or endpoints.
round_robin_prefix A string that when configured automatically creates a shadow property for each normal property.
ping_interval The frequency of health check pings.
max_ttl The greatest TTL allowed before failure.
default_health_max The absolute limit beyond which IPs are declared unhealthy.
map_update_interval How often new maps are generated for performance domains.
max_properties Maximum number of associated properties with a domain.
max_resources Maximum amount of associated resources with a domain.
max_test_timeout Maximum liveness test duration before the test fails. The range is 0.001 to 60 seconds.
default_health_multiplier The value used as a factor in the health cut-off score product. The default value is 1.5.
min_ttl The lowest TTL allowed before failure.
default_max_unreachable_penalty The penalty value added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value.
default_health_threshold A value used as a factor in the health cut-off score product when its value is greater than the minimum liveness score. The default value is 4.
min_test_interval The minimum allowed liveness test interval. Configurations specifying liveness test intervals smaller than this fail validation.
ping_packet_size The size in bytes of the packet used during health checks.