alicloud_alb_rule
更新时间：
Provides a Application Load Balancer (ALB) Rule resource.
For information about Application Load Balancer (ALB) Rule and how to use it, see What is Rule.
-> NOTE: Available since v1.133.0.
-> NOTE: This version only supports forwarding rules in the request direction.
Example Usage
Basic Usage
variable "name" {
default = "tf_example"
}
data "alicloud_alb_zones" "default" {
}
data "alicloud_resource_manager_resource_groups" "default" {
}
resource "alicloud_vpc" "default" {
vpc_name = var.name
cidr_block = "10.4.0.0/16"
}
resource "alicloud_vswitch" "default" {
count = 2
vpc_id = alicloud_vpc.default.id
cidr_block = format("10.4.%d.0/24", count.index + 1)
zone_id = data.alicloud_alb_zones.default.zones[count.index].id
vswitch_name = format("${var.name}_%d", count.index + 1)
}
resource "alicloud_alb_load_balancer" "default" {
vpc_id = alicloud_vpc.default.id
address_type = "Internet"
address_allocated_mode = "Fixed"
load_balancer_name = var.name
load_balancer_edition = "Standard"
resource_group_id = data.alicloud_resource_manager_resource_groups.default.groups.0.id
load_balancer_billing_config {
pay_type = "PayAsYouGo"
}
tags = {
Created = "TF"
}
zone_mappings {
vswitch_id = alicloud_vswitch.default.0.id
zone_id = data.alicloud_alb_zones.default.zones.0.id
}
zone_mappings {
vswitch_id = alicloud_vswitch.default.1.id
zone_id = data.alicloud_alb_zones.default.zones.1.id
}
}
resource "alicloud_alb_server_group" "default" {
protocol = "HTTP"
vpc_id = alicloud_vpc.default.id
server_group_name = var.name
resource_group_id = data.alicloud_resource_manager_resource_groups.default.groups.0.id
health_check_config {
health_check_enabled = "false"
}
sticky_session_config {
sticky_session_enabled = "false"
}
tags = {
Created = "TF"
}
}
resource "alicloud_alb_listener" "default" {
load_balancer_id = alicloud_alb_load_balancer.default.id
listener_protocol = "HTTP"
listener_port = 80
listener_description = var.name
default_actions {
type = "ForwardGroup"
forward_group_config {
server_group_tuples {
server_group_id = alicloud_alb_server_group.default.id
}
}
}
}
resource "alicloud_alb_rule" "default" {
rule_name = var.name
listener_id = alicloud_alb_listener.default.id
priority = "555"
rule_conditions {
cookie_config {
values {
key = "created"
value = "tf"
}
}
type = "Cookie"
}
rule_actions {
forward_group_config {
server_group_tuples {
server_group_id = alicloud_alb_server_group.default.id
}
}
order = "9"
type = "ForwardGroup"
}
}
Argument Reference
The following arguments are supported:
listener_id- (Required, ForceNew) The ID of the listener to which the forwarding rule belongs.rule_name- (Required) The name of the forwarding rule. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.priority- (Required, Int) The priority of the rule. Valid values: 1 to 10000. A smaller value indicates a higher priority. Note: The priority of each rule within the same listener must be unique.direction- (Optional, ForceNew, Available since v1.205.0) The direction to which the forwarding rule is applied. Default value:Request. Valid values:Request: The forwarding rule is applied to the client requests received by ALB.Response: The forwarding rule is applied to the responses returned by backend servers.
dry_run- (Optional, Bool) Specifies whether to precheck this request.rule_actions- (Required, Set) The actions of the forwarding rules. Seerule_actionsbelow.rule_conditions- (Required, Set) The conditions of the forwarding rule. Seerule_conditionsbelow.
rule_actions
The rule_actions supports the following:
order- (Required, Int) The order of the forwarding rule actions. Valid values:1to50000. The actions are performed in ascending order. You cannot leave this parameter empty. Each value must be unique.type- (Required) The action type. Valid values:ForwardGroup,Redirect,FixedResponse,Rewrite,InsertHeader,RemoveHeader,TrafficLimit,TrafficMirrorandCors. Note: The preceding actions can be classified into two types:FinalType: A forwarding rule can contain only oneFinalTypeaction, which is executed last. This type of action can contain only oneForwardGroup,RedirectorFixedResponseaction.ExtType: A forwarding rule can contain one or moreExtTypeactions, which are executed beforeFinalTypeactions and need to coexist with theFinalTypeactions. This type of action can contain multipleInsertHeaderactions or oneRewriteaction. NOTE: TheTrafficLimitandTrafficMirroroption is available since 1.162.0. NOTE: From version 1.205.0,typecan be set toCors.fixed_response_config- (Optional, Set) The configuration of the fixed response. Seefixed_response_configbelow.forward_group_config- (Optional, Set) The forward response action within ALB. Seeforward_group_configbelow.insert_header_config- (Optional, Set) The configuration of the inserted header field. Seeinsert_header_configbelow.remove_header_config- (Optional, Set) The configuration of the inserted header field. Seeremove_header_configbelow.redirect_config- (Optional, Set) The configuration of the external redirect action. Seeredirect_configbelow.rewrite_config- (Optional, Set) The redirect action within ALB. Seerewrite_configbelow.traffic_limit_config- (Optional, Set, Available since v1.162.0) The Flow speed limit. Seetraffic_limit_configbelow.traffic_mirror_config- (Optional, Set, Available since v1.162.0) The Traffic mirroring. Seetraffic_mirror_configbelow.cors_config- (Optional, Set, Available since v1.205.0) Request forwarding based on CORS. Seecors_configbelow.
rule_actions-fixed_response_config
The fixed_response_config supports the following:
content- (Required) The fixed response. The response cannot exceed 1 KB in size and can contain only ASCII characters.content_type- (Optional) The format of the fixed response. Valid values:text/plain,text/css,text/html,application/javascript, andapplication/json.http_code- (Optional) The HTTP status code of the response. The code must be anHTTP_2xx,HTTP_4xxorHTTP_5xx.xis a digit.
rule_actions-forward_group_config
The forward_group_config supports the following:
server_group_tuples- (Optional, Set) The destination server group to which requests are forwarded. Seeserver_group_tuplesbelow.server_group_sticky_session- (Optional, Set, Available since v1.179.0) The configuration of session persistence for server groups. Seeserver_group_sticky_sessionbelow.
rule_actions-forward_group_config-server_group_tuples
The server_group_tuples supports the following:
server_group_id- (Optional) The ID of the destination server group to which requests are forwarded.weight- (Optional, Int, Available since v1.162.0) The Weight of server group. Default value:100. NOTE: This attribute is required when the number ofserver_group_tuplesis greater than 2.
rule_actions-forward_group_config-server_group_sticky_session
The server_group_sticky_session supports the following:
enabled- (Optional, Bool, Available since v1.179.0) Whether to enable session persistence.timeout- (Optional, Int, Available since v1.179.0) The timeout period. Unit: seconds. Valid values:1to86400. Default value:1000.
rule_actions-insert_header_config
The insert_header_config supports the following:
key- (Optional) The name of the inserted header field. The name must be 1 to 40 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). You cannot use the same name in InsertHeader. Note You cannot use Cookie or Host in the name.value- (Optional) The content of the inserted header field. Valid values:- If the
value_typeis set toSystemDefined, the following values are used:ClientSrcPort: the port of the client.ClientSrcIp: the IP address of the client.Protocol: the protocol used by client requests (HTTP or HTTPS).SLBId: the ID of the ALB instance.SLBPort: the listener port of the ALB instance.
- If the
value_typeis set toUserDefined, thevaluemust be 1 to 128 characters in length, and can contain lowercase letters, printable characters whose ASCII value is ch >= 32 && ch < 127, and wildcards such as asterisks (*) and question marks (?). The header value cannot start or end with a space. - If the
value_typeis set toReferenceHeader, thevaluemust be 1 to 128 characters in length, and can contain lowercase letters, digits, underscores (_), and hyphens (-).
- If the
value_type- (Optional) The value type of the inserted header field. Valid values:UserDefined: a custom valueReferenceHeader: uses a field of the user request header.SystemDefined: a system value.
rule_actions-remove_header_config
The remove_header_config supports the following:
key- (Optional) The name of the removed header field. It can be 1 to 40 characters in length and supports upper and lower case letters a to z, numbers, underscores (_), and dashes (-). Header field names cannot be used repeatedly in RemoveHeader.- Request Direction: The header name cannot be set to the following fields (case insensitive):slb-id, slb-ip, x-forwarded-for, x-forwarded-proto, x-forwarded-eip, x-forwarded-port, x-forwarded-client-srcport, connection, upgrade, content-length, transfer-encoding, keep-alive, te, host, cookie, remoteip, and authority.
- Response Direction: The header name cannot be set to the following fields (case insensitive):connection, upgrade, content-length, transfer-encoding.
rule_actions-redirect_config
The redirect_config supports the following:
host- (Optional) The host name of the destination to which requests are directed. The host name must meet the following rules: The host name must be 3 to 128 characters in length, and can contain letters, digits, hyphens (-), periods (.), asterisks (), and question marks (?). The host name must contain at least one period (.), and cannot start or end with a period (.). The rightmost domain label can contain only letters, asterisks () and question marks (?) and cannot contain digits or hyphens (-). Other domain labels cannot start or end with a hyphen (-). You can include asterisks (*) and question marks (?) anywhere in a domain label. Default value: ${host}. You cannot use this value with other characters at the same time.http_code- (Optional) The redirect method. Valid values:301,302,303,307, and308.path- (Optional) The path of the destination to which requests are directed. Valid values: The path must be 1 to 128 characters in length, and start with a forward slash (/). The path can contain letters, digits, asterisks (*), question marks (?) and the following special characters: $ - _ . + / & ~ @ :. It cannot contain the following special characters: " % # ; ! ( ) [ ] ^ , ”. The path is case-sensitive. Default value: ${path}. You can also reference ${host}, ${protocol}, and ${port}. Each variable can appear at most once. You can use the preceding variables at the same time, or use them with a valid string.port- (Optional) The port of the destination to which requests are redirected. Valid values: 1 to 63335. Default value: ${port}. You cannot use this value together with other characters at the same time.protocol- (Optional) The protocol of the requests to be redirected. Valid values:HTTPandHTTPS. Default value:${protocol}. You cannot use this value together with other characters at the same time. Note HTTPS listeners can redirect only HTTPS requests.query- (Optional) The query string of the request to be redirected. The query string must be 1 to 128 characters in length, can contain letters and printable characters. It cannot contain the following special characters: # [ ] { } \ | < > &. Default value: ${query}. You can also reference ${host}, ${protocol}, and ${port}. Each variable can appear at most once. You can use the preceding variables at the same time, or use them together with a valid string.
rule_actions-rewrite_config
The rewrite_config supports the following:
host- (Optional) The host name of the destination to which requests are redirected within ALB. Valid values: The host name must be 3 to 128 characters in length, and can contain letters, digits, hyphens (-), periods (.), asterisks (), and question marks (?). The host name must contain at least one period (.), and cannot start or end with a period (.). The rightmost domain label can contain only letters, asterisks () and question marks (?) and cannot contain digits or hyphens (-). Other domain labels cannot start or end with a hyphen (-). You can include asterisks (*) and question marks (?) anywhere in a domain label. Default value: ${host}. You cannot use this value with other characters at the same time.path- (Optional) The path to which requests are to be redirected within ALB. Valid values: The path must be 1 to 128 characters in length, and start with a forward slash (/). The path can contain letters, digits, asterisks (*), question marks (?)and the following special characters: $ - _ . + / & ~ @ :. It cannot contain the following special characters: " % # ; ! ( ) [ ] ^ , ”. The path is case-sensitive. Default value: ${path}. This value can be used only once. You can use it with a valid string.query- (Optional) The query string of the request to be redirected within ALB. The query string must be 1 to 128 characters in length, can contain letters and printable characters. It cannot contain the following special characters: # [ ] { } \ | < > &. Default value: ${query}. This value can be used only once. You can use it with a valid string.
rule_actions-traffic_limit_config
The traffic_limit_config supports the following:
qps- (Optional, Int) The Number of requests per second. Valid values:1to100000.per_ip_qps- (Optional, Int) The number of requests per second for a single IP address. Value range: 1~1000000. Note: If the QPS parameter is also configured, the value of the PerIpQps parameter must be smaller than the value of the QPS parameter.
rule_actions-traffic_mirror_config
The traffic_mirror_config supports the following:
target_type- (Optional) The Mirror target type.mirror_group_config- (Optional, Set) The Traffic is mirrored to the server group. Seemirror_group_configbelow.
rule_actions-traffic_mirror_config-mirror_group_config
The mirror_group_config supports the following:
server_group_tuples- (Optional, Set) The destination server group to which requests are forwarded. Seeserver_group_tuplesbelow.
rule_actions-traffic_mirror_config-mirror_group_config-server_group_tuples
The server_group_tuples supports the following:
server_group_id- (Optional) The ID of the destination server group to which requests are forwarded.
rule_actions-cors_config
The cors_config supports the following:
allow_origin- (Optional, List) The allowed origins of CORS requests.allow_methods- (Optional, List) The allowed HTTP methods for CORS requests. Valid values:GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH.allow_headers- (Optional, List) The allowed headers for CORS requests.expose_headers- (Optional, List) The headers that can be exposed.allow_credentials- (Optional) Specifies whether credentials can be passed during CORS operations. Valid values:on,off.max_age- (Optional, Int) The maximum cache time of preflight requests in the browser. Unit: seconds. Valid values:-1to172800.
rule_conditions
The rule_conditions supports the following:
type- (Required) The type of the forwarding rule. Valid values:Host: Requests are forwarded based on hosts.Path: Requests are forwarded based on the path.Header: Requests are forwarded based on the HTTP header field.QueryString: Requests are forwarded based on the query string.Method: Request are forwarded based on the request method.Cookie: Requests are forwarded based on the cookie.SourceIp: Requests are forwarded based on the source ip. NOTE: TheSourceIpoption is available since 1.162.0.ResponseHeader: Response header. NOTE: TheSourceIpoption is available since 1.213.1.ResponseStatusCode: Response status code. NOTE: TheSourceIpoption is available since 1.213.1.
cookie_config- (Optional, Set) The configuration of the cookie. See Seecookie_configbelow.header_config- (Optional, Set) The configuration of the header field. Seeheader_configbelow.response_header_config- (Optional, Set) The configuration of the header field. Seeresponse_header_configbelow.response_status_code_config- (Optional, Set) The configuration of the header field. Seeresponse_status_code_configbelow.host_config- (Optional, Set) The configuration of the host field. Seehost_configbelow.method_config- (Optional, Set) The configuration of the request method. Seemethod_configbelow.path_config- (Optional, Set) The configuration of the path for the request to be forwarded. Seepath_configbelow.query_string_config- (Optional, Set) The configuration of the query string. Seequery_string_configbelow.source_ip_config- (Optional, Set, Available since v1.162.0) The Based on source IP traffic matching. Required and valid when Type is SourceIP. Seesource_ip_configbelow.
rule_conditions-cookie_config
The cookie_config supports the following:
values- (Optional, Set) The values of the cookie. Seevaluesbelow.
rule_conditions-cookie_config-values
The values supports the following:
key- (Optional) The key of the cookie.value- (Optional) The value of the cookie.
rule_conditions-header_config
The header_config supports the following:
key- (Optional) The key of the header field. The key must be 1 to 40 characters in length, and can contain letters, digits, hyphens (-) and underscores (_). The key does not support Cookie or Host.values- (Optional, List) The value of the header field. The value must be 1 to 128 characters in length, and can contain lowercase letters, printable ASCII characters whose values are ch >= 32 && ch < 127, asterisks (*), and question marks (?). The value cannot start or end with a space.
rule_conditions-response_header_config
The response_header_config supports the following:
key- (Optional) The key of the header field. The key must be 1 to 40 characters in length, and can contain letters, digits, hyphens (-) and underscores (_). The key does not support Cookie or Host.values- (Optional, List) The value of the header field. The value must be 1 to 128 characters in length, and can contain lowercase letters, printable ASCII characters whose values are ch >= 32 && ch < 127, asterisks (*), and question marks (?). The value cannot start or end with a space.
rule_conditions-response_status_code_config
The response_status_code_config supports the following:
values- (Optional, List) Response status code list.
rule_conditions-host_config
The host_config supports the following:
values- (Optional, List) The name of the host. **Note: ** The host name must meet the following rules: The hostname must be 3 to 128 characters in length, and can contain lowercase letters, digits, hyphens (-), periods (.), asterisks (), and question marks (?). The host name must contain at least one period (.), and cannot start or end with a period (.). The rightmost field can contain only letters and wildcards, and cannot contain digits or hyphens (-). Other fields cannot start or end with a hyphen (-). You can enter asterisks () and question marks (?) anywhere in a field.
rule_conditions-method_config
The method_config supports the following:
values- (Optional, List) The request method. Valid values:HEAD,GET,POST,OPTIONS,PUT,PATCH, andDELETE.
rule_conditions-path_config
The path_config supports the following:
values- (Optional, List) The path of the request to be forwarded. The path must be 1 to 128 characters in length and must start with a forward slash (/). The path can contain letters, digits, and the following special characters: $ - _ . + / & ~ @ :. It cannot contain the following special characters: " % # ; ! ( ) [ ] ^ , ". The value is case-sensitive, and can contain asterisks (*) and question marks (?).
rule_conditions-query_string_config
The query_string_config supports the following:
values- (Optional, Set) The query string. Seevaluesbelow.
rule_conditions-query_string_config-values
The values supports the following:
key- (Optional) The key must be 1 to 100 characters in length, and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The key cannot contain spaces or the following special characters: # [ ] { } \ | < > &.value- (Optional) The value must be 1 to 128 characters in length, and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The value cannot contain spaces or the following special characters: # [ ] { } \ | < > &.
rule_conditions-source_ip_config
The source_ip_config supports the following:
values- (Optional, List) Add one or more IP addresses or IP address segments. You can add up to 5 forwarding rules in a SourceIp.
Attributes Reference
The following attributes are exported:
id- The resource ID in terraform of Rule.status- The status of the resource.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 2 mins) Used when create the Rule.update- (Defaults to 2 mins) Used when update the Rule.delete- (Defaults to 2 mins) Used when delete the Rule.
Import
Application Load Balancer (ALB) Rule can be imported using the id, e.g.
$ terraform import alicloud_alb_rule.example <id>
文档内容是否对您有帮助？