alicloud_ga_listener_Terraform(Terraform)-阿里云帮助中心

Provides a Global Accelerator (GA) Listener resource.

For information about Global Accelerator (GA) Listener and how to use it, see What is Listener.

-> NOTE: Available since v1.111.0.

Example Usage

Basic Usage

resource "alicloud_ga_accelerator" "default" {
  duration        = 1
  auto_use_coupon = true
  spec            = "1"
}

resource "alicloud_ga_bandwidth_package" "default" {
  bandwidth      = 100
  type           = "Basic"
  bandwidth_type = "Basic"
  payment_type   = "PayAsYouGo"
  billing_type   = "PayBy95"
  ratio          = 30
}

resource "alicloud_ga_bandwidth_package_attachment" "default" {
  accelerator_id       = alicloud_ga_accelerator.default.id
  bandwidth_package_id = alicloud_ga_bandwidth_package.default.id
}

resource "alicloud_ga_listener" "default" {
  accelerator_id = alicloud_ga_bandwidth_package_attachment.default.accelerator_id
  port_ranges {
    from_port = 80
    to_port   = 80
  }
}

Argument Reference

The following arguments are supported:

accelerator_id - (Required, ForceNew) The accelerator id.
protocol - (Optional) Type of network transport protocol monitored. Default value: TCP. Valid values: TCP, UDP, HTTP, HTTPS.
proxy_protocol - (Optional, Bool) The proxy protocol of the listener. Default value: false. Valid values:
- true: Turn on the keep client source IP function. After it is turned on, the back-end service is supported to view the original IP address of the client.
- false: Keep client source IP function is not turned on.
security_policy_id - (Optional, Available since v1.183.0) The ID of the security policy. NOTE: Only HTTPS listeners support this parameter. Valid values:
- tls_cipher_policy_1_0:
  - Supported TLS versions: TLS 1.0, TLS 1.1, and TLS 1.2.
  - Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA.
- tls_cipher_policy_1_1:
  - Supported TLS versions: TLS 1.1 and TLS 1.2.
  - Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA.
- tls_cipher_policy_1_2:
  - Supported TLS version: TLS 1.2.
  - Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA.
- tls_cipher_policy_1_2_strict:
  - Supported TLS version: TLS 1.2.
  - Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA.
- tls_cipher_policy_1_2_strict_with_1_3:
  - Supported TLS versions: TLS 1.2 and TLS 1.3.
  - Supported cipher suites: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA.
listener_type - (Optional, ForceNew, Available since v1.196.0) The routing type of the listener. Default Value: Standard. Valid values:
- Standard: intelligent routing.
- CustomRouting: custom routing.
http_version - (Optional, Available since v1.220.0) The maximum version of the HTTP protocol. Default Value: http2. Valid values: http1.1, http2, http3. -> NOTE: http_version is only valid when protocol is HTTPS.
idle_timeout - (Optional, Int, Available since v1.227.0) The timeout period of idle connections. Unit: seconds. Valid values:
- If you set protocol to TCP. Default Value: 900. Valid values: 10 to 900.
- If you set protocol to UDP. Default Value: 20. Valid values: 10 to 20.
- If you set protocol to HTTP or HTTPS. Default Value: 15. Valid values: 1 to 60.
request_timeout - (Optional, Int, Available since v1.227.0) The timeout period for HTTP or HTTPS requests. Unit: seconds. Default Value: 60. Valid values: 1 to 180. -> NOTE: request_timeout is only valid when protocol is HTTP or HTTPS.
client_affinity - (Optional) The clientAffinity of the listener. Default value: NONE. Valid values:
- NONE: client affinity is not maintained, that is, connection requests from the same client cannot always be directed to the same terminal node.
- SOURCE_IP: maintain client affinity. When a client accesses a stateful application, all requests from the same client can be directed to the same terminal node, regardless of the source port and protocol.
name - (Optional) The name of the listener. The length of the name is 2-128 characters. It starts with uppercase and lowercase letters or Chinese characters. It can contain numbers and underscores and dashes.
description - (Optional) The description of the listener.
certificates - (Optional, Set) The certificates of the listener. See certificates below. -> NOTE: This parameter needs to be configured only for monitoring of the HTTPS protocol.
port_ranges - (Required, Set) The portRanges of the listener. See port_ranges below. -> NOTE: For HTTP or HTTPS protocol monitoring, only one monitoring port can be configured, that is, the start monitoring port and end monitoring port should be the same.
forwarded_for_config - (Optional, Set, Available since v1.207.0) The XForward headers. See forwarded_for_config below.

`certificates`

The certificates supports the following:

id - (Optional) The id of the certificate.

`port_ranges`

The port_ranges supports the following:

from_port - (Required, Int) The initial listening port used to receive requests and forward them to terminal nodes.
to_port - (Required, Int) The end listening port used to receive requests and forward them to terminal nodes.

`forwarded_for_config`

The forwarded_for_config supports the following:

forwarded_for_ga_id_enabled - (Optional, Bool) Specifies whether to use the GA-ID header to retrieve the ID of the GA instance. Default value: false. Valid values:
- true: yes.
- false: no.
forwarded_for_ga_ap_enabled - (Optional, Bool) Specifies whether to use the GA-AP header to retrieve the information about acceleration regions. Default value: false. Valid values:
- true: yes.
- false: no.
forwarded_for_proto_enabled - (Optional, Bool) Specifies whether to use the GA-X-Forward-Proto header to retrieve the listener protocol of the GA instance. Default value: false. Valid values:
- true: yes.
- false: no.
forwarded_for_port_enabled - (Optional, Bool) Specifies whether to use the GA-X-Forward-Port header to retrieve the listener ports of the GA instance. Default value: false. Valid values:
- true: yes.
- false: no.
real_ip_enabled - (Optional, Bool) Specifies whether to use the X-Real-IP header to retrieve client IP addresses. Default value: false. Valid values:
- true: yes.
- false: no. -> NOTE: These forwarded_for_ga_id_enabled, forwarded_for_ga_ap_enabled, forwarded_for_proto_enabled, forwarded_for_port_enabled, real_ip_enabled are available only when you create an HTTPS or HTTP listener.

Attributes Reference

The following attributes are exported:

id - The resource ID in terraform of Listener.
status - The status of the listener.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

create - (Defaults to 15 mins) Used when create the Listener.
update - (Defaults to 3 mins) Used when update the Listener.
delete - (Defaults to 10 mins) Used when delete the Listener.

Import

Ga Listener can be imported using the id, e.g.

$ terraform import alicloud_ga_listener.example <id>