Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
posquit0 committed Sep 21, 2023
1 parent 9e14925 commit b1ab9c3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 9 deletions.
2 changes: 1 addition & 1 deletion modules/lattice-service-listener/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This module creates following resources.
| <a name="input_resource_group_description"></a> [resource\_group\_description](#input\_resource\_group\_description) | (Optional) The description of Resource Group. | `string` | `"Managed by Terraform."` | no |
| <a name="input_resource_group_enabled"></a> [resource\_group\_enabled](#input\_resource\_group\_enabled) | (Optional) Whether to create Resource Group to find and group AWS resources which are created by this module. | `bool` | `true` | no |
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | (Optional) The name of Resource Group. A Resource Group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`. | `string` | `""` | no |
| <a name="input_rules"></a> [rules](#input\_rules) | (Optional) A list of rules to enable content-based routing to the target groups that make up the service. Each rule consists of a priority, one or more actions, and one or more conditions.<br> Each block of `rules` block as defined below.<br> (Required) `priority` - The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.<br> (Optional) `name` - A rule name can describe the purpose of the rule or the type of traffic it is intended to handle. Rule names can't be changed after creation. Defaults to `$(service)-$(priority)`.<br> (Required) `conditions` - The rule conditions. `conditions` block as defined below.<br> (Optional) `method` - The condition of HTTP request method. Valid values are `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`.<br> (Required) `path` - The condition of HTTP request path. `path` block as defined below.<br> (Required) `value` - The path pattern. The pattern must start with `/`.<br> (Optional) `operator` - The operator that you want to use to determine whether an HTTP request path matches the conditions. Valid values are `EXACT`, `PREFIX`. Defaults to `PREFIX`.<br> (Optional) `case_sensitive` - Whether to match the `value` condition using a case-sensitive match. Defaults to `false`.<br> (Optional) `headers` - The condition of HTTP request headers. Each block of `headers` as defined below.<br> (Required) `name` - The name of the HTTP header field.<br> (Required) `value` - The value of the HTTP header field.<br> (Optional) `operator` - The operator that you want to use to determine whether an HTTP header matches the conditions. Valid values are `EXACT`, `PREFIX`, `CONTAINS`. Defaults to `EXACT`.<br> (Optional) `case_sensitive` - Whether to match the `value` condition using a case-sensitive match. Defaults to `false`.<br> (Required) `action_type` - The action type for the rule of the service. Valid values are `FORWARD`, `FIXED_RESPONSE`.<br> (Optional) `action_parameters` - The configuration for the parameters of the routing action. `action_parameters` block as defined below.<br> (Optional) `status_code` - Custom HTTP status code to drop client requests and return a custom HTTP response. Valid values are `404`. Only supported if `action_type` is `FIXED_RESPONSE`.<br> (Optional) `destinations` - A list of one or more target groups to route traffic. Only supported if `action_type` is `FORWARD`. Each item of `destinations` block as defined below.<br> (Required) `target_group` - The ID or ARN of the target group to which to route traffic.<br> (Optional) `weight` - The weight to use routing traffic to `target_group`. how requests are distributed to the target group. Only required if you specify multiple target groups for a forward action. For example, if you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. Valid value is `0` to `999`. Defaults to `100`. | <pre>list(object({<br> priority = number<br> name = optional(string)<br><br> conditions = object({<br> method = optional(string)<br> path = object({<br> value = string<br> operator = optional(string, "PREFIX")<br> case_sensitive = optional(bool, false)<br> })<br> headers = optional(list(object({<br> name = string<br> value = string<br> operator = optional(string, "EXACT")<br> case_sensitive = optional(bool, false)<br> })), [])<br> })<br><br> action_type = string<br> action_parameters = optional(object({<br> status_code = optional(number, 404)<br> destinations = optional(list(object({<br> target_group = string<br> weight = optional(number, 100)<br> })), [])<br> }), {})<br> }))</pre> | `[]` | no |
| <a name="input_rules"></a> [rules](#input\_rules) | (Optional) A list of rules to enable content-based routing to the target groups that make up the service. Each rule consists of a priority, one or more actions, and one or more conditions. Each block of `rules` block as defined below.<br> (Required) `priority` - The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.<br> (Optional) `name` - A rule name can describe the purpose of the rule or the type of traffic it is intended to handle. Rule names can't be changed after creation. Defaults to `$(service)-$(priority)`.<br> (Required) `conditions` - The rule conditions. `conditions` block as defined below.<br> (Optional) `method` - The condition of HTTP request method. Valid values are `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`.<br> (Required) `path` - The condition of HTTP request path. `path` block as defined below.<br> (Required) `value` - The path pattern. The pattern must start with `/`.<br> (Optional) `operator` - The operator that you want to use to determine whether an HTTP request path matches the conditions. Valid values are `EXACT`, `PREFIX`. Defaults to `PREFIX`.<br> (Optional) `case_sensitive` - Whether to match the `value` condition using a case-sensitive match. Defaults to `false`.<br> (Optional) `headers` - The condition of HTTP request headers. Each block of `headers` as defined below.<br> (Required) `name` - The name of the HTTP header field.<br> (Required) `value` - The value of the HTTP header field.<br> (Optional) `operator` - The operator that you want to use to determine whether an HTTP header matches the conditions. Valid values are `EXACT`, `PREFIX`, `CONTAINS`. Defaults to `EXACT`.<br> (Optional) `case_sensitive` - Whether to match the `value` condition using a case-sensitive match. Defaults to `false`.<br> (Required) `action_type` - The action type for the rule of the service. Valid values are `FORWARD`, `FIXED_RESPONSE`.<br> (Optional) `action_parameters` - The configuration for the parameters of the routing action. `action_parameters` block as defined below.<br> (Optional) `status_code` - Custom HTTP status code to drop client requests and return a custom HTTP response. Valid values are `404`. Only supported if `action_type` is `FIXED_RESPONSE`.<br> (Optional) `destinations` - A list of one or more target groups to route traffic. Only supported if `action_type` is `FORWARD`. Each item of `destinations` block as defined below.<br> (Required) `target_group` - The ID or ARN of the target group to which to route traffic.<br> (Optional) `weight` - The weight to use routing traffic to `target_group`. how requests are distributed to the target group. Only required if you specify multiple target groups for a forward action. For example, if you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. Valid value is `0` to `999`. Defaults to `100`. | <pre>list(object({<br> priority = number<br> name = optional(string)<br><br> conditions = object({<br> method = optional(string)<br> path = object({<br> value = string<br> operator = optional(string, "PREFIX")<br> case_sensitive = optional(bool, false)<br> })<br> headers = optional(list(object({<br> name = string<br> value = string<br> operator = optional(string, "EXACT")<br> case_sensitive = optional(bool, false)<br> })), [])<br> })<br><br> action_type = string<br> action_parameters = optional(object({<br> status_code = optional(number, 404)<br> destinations = optional(list(object({<br> target_group = string<br> weight = optional(number, 100)<br> })), [])<br> }), {})<br> }))</pre> | `[]` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) A map of tags to add to all resources. | `map(string)` | `{}` | no |

## Outputs
Expand Down
3 changes: 1 addition & 2 deletions modules/lattice-service-listener/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@ variable "default_action_parameters" {

variable "rules" {
description = <<EOF
(Optional) A list of rules to enable content-based routing to the target groups that make up the service. Each rule consists of a priority, one or more actions, and one or more conditions.
Each block of `rules` block as defined below.
(Optional) A list of rules to enable content-based routing to the target groups that make up the service. Each rule consists of a priority, one or more actions, and one or more conditions. Each block of `rules` block as defined below.
(Required) `priority` - The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
(Optional) `name` - A rule name can describe the purpose of the rule or the type of traffic it is intended to handle. Rule names can't be changed after creation. Defaults to `$(service)-$(priority)`.
(Required) `conditions` - The rule conditions. `conditions` block as defined below.
Expand Down
Loading

0 comments on commit b1ab9c3

Please sign in to comment.