|
| 1 | +--- |
| 2 | +subcategory: "Dedicated Load Balance (Dedicated ELB)" |
| 3 | +layout: "huaweicloud" |
| 4 | +page_title: "HuaweiCloud: huaweicloud_elb_member_check_task" |
| 5 | +description: |- |
| 6 | + Manages an ELB member check task resource within HuaweiCloud. |
| 7 | +--- |
| 8 | + |
| 9 | +# huaweicloud_elb_member_check_task |
| 10 | + |
| 11 | +Manages an ELB member check task resource within HuaweiCloud. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```hcl |
| 16 | +variable "member_id" {} |
| 17 | +variable "listener_id" {} |
| 18 | +
|
| 19 | +resource "huaweicloud_elb_member_check_task" "test" { |
| 20 | + member_id = var.member_id |
| 21 | + listener_id = var.listener_id |
| 22 | + subject = "all" |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | +## Argument Reference |
| 27 | + |
| 28 | +The following arguments are supported: |
| 29 | + |
| 30 | +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the resource. |
| 31 | + If omitted, the provider-level region will be used. Changing this creates a new resource. |
| 32 | + |
| 33 | +* `member_id` - (Required, String, NonUpdatable) Specifies the backend server ID. |
| 34 | + |
| 35 | +* `listener_id` - (Required, String, NonUpdatable) Specifies the ID of a listener to query the status of the backend |
| 36 | + servers that are associated with this listener. |
| 37 | + |
| 38 | +* `subject` - (Required, String, NonUpdatable) Specifies the check items. Value options: |
| 39 | + + **securityGroup**: security group checks |
| 40 | + + **networkAcl**: network ACL checks |
| 41 | + + **config**: health check port checks |
| 42 | + + **all**: all check items |
| 43 | + |
| 44 | +## Attribute Reference |
| 45 | + |
| 46 | +In addition to all arguments above, the following attributes are exported: |
| 47 | + |
| 48 | +* `id` - The resource ID. The value is the project ID. |
| 49 | + |
| 50 | +* `status` - Indicates the status of a backend server check task. |
| 51 | + |
| 52 | +* `result` - Indicates the result of each check item. |
| 53 | + The [result](#result_struct) structure is documented below. |
| 54 | + |
| 55 | +* `check_item_total_num` - Indicates the total number of check items. |
| 56 | + |
| 57 | +* `check_item_finished_num` - Indicates the number of checked items. |
| 58 | + |
| 59 | +* `created_at` - Indicates the task creation time. |
| 60 | + |
| 61 | +* `updated_at` - Indicates the task update time. |
| 62 | + |
| 63 | +<a name="result_struct"></a> |
| 64 | +The `result` block supports: |
| 65 | + |
| 66 | +* `config` - Indicates the configuration check. |
| 67 | + The [config](#result_group_struct) structure is documented below. |
| 68 | + |
| 69 | +* `acl` - Indicates the network ACL rule check. |
| 70 | + The [acl](#result_group_struct) structure is documented below. |
| 71 | + |
| 72 | +* `security_group` - Indicates the security group rule check. |
| 73 | + The [security_group](#result_group_struct) structure is documented below. |
| 74 | + |
| 75 | +<a name="result_group_struct"></a> |
| 76 | +The `config`, `acl`, `security_group` block supports: |
| 77 | + |
| 78 | +* `check_result` - Indicates the check result. **true** indicates that the check is passed, and **false** indicates that |
| 79 | + the check is not passed. |
| 80 | + |
| 81 | +* `check_items` - Indicates the summary of grouped check items. |
| 82 | + The [check_items](#check_items_struct) structure is documented below. |
| 83 | + |
| 84 | +* `check_result` - Indicates the result of a backend server check task. The value can be **processed**, **processing** |
| 85 | + or **failed**. |
| 86 | + |
| 87 | +<a name="check_items_struct"></a> |
| 88 | +The `check_items` block supports: |
| 89 | + |
| 90 | +* `name` - Indicates the check item name. |
| 91 | + |
| 92 | +* `reason` - Indicates the exception cause. |
| 93 | + |
| 94 | +* `severity` - Indicates the exception severity, which can be **Major (severe)** or **Tips (informational)**. |
| 95 | + |
| 96 | +* `subject` - Indicates the check type. **config** indicates configuration check. |
| 97 | + |
| 98 | +* `job_id` - Indicates the task ID. |
| 99 | + |
| 100 | +* `reason_template` - Indicates the exception reason template. |
| 101 | + |
| 102 | +* `reason_params` - Indicates the exception variables, which is used to dynamically generate exception causes based on |
| 103 | + the exception cause template. |
| 104 | + |
| 105 | +## Timeouts |
| 106 | + |
| 107 | +This resource provides the following timeouts configuration options: |
| 108 | + |
| 109 | +* `create` - Default is 10 minutes. |
| 110 | + |
| 111 | +## Import |
| 112 | + |
| 113 | +The ELB member check task resource can be imported using the `id`, e.g. |
| 114 | + |
| 115 | +```bash |
| 116 | +$ terraform import huaweicloud_elb_member_check_task.test <id> |
| 117 | +``` |
0 commit comments