For AI agents: visit https://techdocs.akamai.com/terraform/v8.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Create and update a load balancer configuration or remove a load balancer configuration from your Terraform state. Import the resource if the origins for this resource already exist on the server.
🚧
Running terraform destroy does not delete your configuration; it only removes it from your state file. Re-import your configuration to get it back.
Pass an origin ID, a list of your data centers, and any of the optional arguments to create a load balancer.
Argument
Required
Description
origin_id
✔
A user created ID that represents a data center for an application load balancer implementation. Alphanumeric characters and underscores only, and the first and last characters must be alphanumeric.
Note:. The application load balancer cloudlet only supports a setting of APPLICATION_LOAD_BALANCER in the origin behavior of your property's rules.
data_centers
✔
The conditional origins of type CUSTOMER or NETSTORAGE used as data centers in an application load balancer implementation. Contains:
latitude. The latitude for the data center. Value can be up six decimal places.
longitude. The longitude for the data center. Value can be up six decimal places.
country. The country code for the country in which the data center is located.
origin_id. A conditional origin ID.
percent. The percent of traffic that is sent to the data center. The total for all data centers needs to equal 100%.
cloud_service. Whether the data center is a cloud service.
liveness_hosts. A list of the origin servers used to poll data centers in an application load balancer configuration. Servers need to support basic HTTP polling.
hostname. The name of the host to use as a conditional origin.
state_or_province. The state, province, or region where the data center is located.
city. The city in which the data center is located.
cloud_server_host_header_override. Whether the cloud server host header is overridden.
liveness_settings. Health details for a load balanced data center.
port. The port for the test object. The default port is 80 for HTTP and 443 for HTTPS.
protocol. The protocol or scheme for the database, either HTTP or HTTPS.
path. The path to the test object used for liveness testing.
host_header. The host header for a liveness HTTP request.
additional_headers. The additional case-insensitive HTTP header names included mapped to the liveness testing requests.
interval. The frequency of liveness tests in seconds.
peer_certificate_verification. Whether to validate the origin certificate for an HTTPS request.
request_string. The request used for TCP and TCPS tests.
response_string. The response used for TCP and TCPS tests.
status_3xx_failure. Whether the the liveness test fails if a request returns a 3xx redirect status code.
status_4xx_failure. Whether the liveness test fails if a request returns a 4xx client error status code.
status_5xx_failure. Whether the liveness test fails if a request returns a 5xx server error status code.
timeout. The number of seconds the system waits before failing the liveness test.
description
A human-readable description about your load balancing configuration.
balancing_type
The type of load balancing. Value is one of WEIGHTED or PERFORMANCE.
Argument
Required
Description
origin_id
✔
A user created ID that represents a data center for an application load balancer implementation. Alphanumeric characters and underscores only, and the first and last characters must be alphanumeric.
Note:. The application load balancer cloudlet only supports a setting of APPLICATION_LOAD_BALANCER in the origin behavior of your property's rules.
data_centers
✔
The conditional origins of type CUSTOMER or NETSTORAGE used as data centers in an application load balancer implementation. Contains:
latitude. The latitude for the data center. Value can be up six decimal places.
longitude. The longitude for the data center. Value can be up six decimal places.
country. The country code for the country in which the data center is located.
origin_id. A conditional origin ID.
percent. The percent of traffic that is sent to the data center. The total for all data centers needs to equal 100%.
cloud_service. Whether the data center is a cloud service.
liveness_hosts. A list of the origin servers used to poll data centers in an application load balancer configuration. Servers need to support basic HTTP polling.
hostname. The name of the host to use as a conditional origin.
state_or_province. The state, province, or region where the data center is located.
city. The city in which the data center is located.
cloud_server_host_header_override. Whether the cloud server host header is overridden.
liveness_settings. Health details for a load balanced data center.
port. The port for the test object. The default port is 80 for HTTP and 443 for HTTPS.
protocol. The protocol or scheme for the database, either HTTP or HTTPS.
path. The path to the test object used for liveness testing.
host_header. The host header for a liveness HTTP request.
additional_headers. The additional case-insensitive HTTP header names included mapped to the liveness testing requests.
interval. The frequency of liveness tests in seconds.
peer_certificate_verification. Whether to validate the origin certificate for an HTTPS request.
request_string. The request used for TCP and TCPS tests.
response_string. The response used for TCP and TCPS tests.
status_3xx_failure. Whether the the liveness test fails if a request returns a 3xx redirect status code.
status_4xx_failure. Whether the liveness test fails if a request returns a 4xx client error status code.
status_5xx_failure. Whether the liveness test fails if a request returns a 5xx server error status code.
timeout. The number of seconds the system waits before failing the liveness test.
description
A human-readable description about your load balancing configuration.
balancing_type
The type of load balancing. Value is one of WEIGHTED or PERFORMANCE.
Attributes
Returned to you are the version number and any warnings that occurred on creation.
Attribute
Description
version
The version number of the load balancing configuration.
warnings
A list of warnings that occurred during the load balancer configuration activation.