Skip to content

Commit

Permalink
docs(as): Supplement missing documents (#1000)
Browse files Browse the repository at this point in the history
  • Loading branch information
Zippo-Wang authored Sep 11, 2023
1 parent 6c86b70 commit 1607e0d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 15 deletions.
19 changes: 12 additions & 7 deletions docs/data-sources/as_configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,22 @@ The following arguments are supported:

* `image_id` - (Optional, String) Specifies the image ID.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The ID of the list.

* `configurations` - A list of AS configurations.
The [configurations](#instance_configurations) object structure is documented below.

<a name="instance_configurations"></a>
The `configurations` block supports:

* `scaling_configuration_name` - The AS configuration name.

* `instance_config` - The list of information about instance configurations.
The [object](#instance_config_object) structure is documented below.
The [instance_config](#instance_config_object) structure is documented below.

* `status` - The AS configuration status, the value can be **Bound** or **Unbound**.

Expand All @@ -48,7 +50,7 @@ The `instance_config` block supports:

* `image` - The ECS image ID.

* `disk` - The list of disk group information. The [object](#instance_config_disk_object) structure is documented below.
* `disk` - The list of disk group information. The [disk](#instance_config_disk_object) structure is documented below.

* `key_name` - The name of the SSH key pair used to log in to the instance.

Expand All @@ -64,12 +66,12 @@ The `instance_config` block supports:
* `user_data` - The user data to provide when launching the instance.

* `public_ip` - The EIP list of the ECS instance.
The [object](#instance_config_public_ip_object) structure is documented below.
The [public_ip](#instance_config_public_ip_object) structure is documented below.

* `metadata` - The key/value pairs to make available from within the instance.

* `personality` - The list of information about the injected file.
The [object](#instance_config_personality_object) structure is documented below.
The [personality](#instance_config_personality_object) structure is documented below.

<a name="instance_config_disk_object"></a>
The `disk` block supports:
Expand All @@ -86,14 +88,17 @@ The `disk` block supports:
The `public_ip` block supports:

* `eip` - The list of EIP configuration that will be automatically assigned to the instance.
The object structure is documented below.
The [eip](#instance_eip) object structure is documented below.

<a name="instance_eip"></a>
The `eip` block supports:

* `ip_type` - The EIP type.

* `bandwidth` - The list of bandwidth information. The object structure is documented below.
* `bandwidth` - The list of bandwidth information.
The [bandwidth](#instance_bandwidth) object structure is documented below.

<a name="instance_bandwidth"></a>
The `bandwidth` block supports:

* `share_type` - The bandwidth sharing type.
Expand Down
17 changes: 9 additions & 8 deletions docs/data-sources/as_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ The following arguments are supported:
- **DELETING**: indicates that the AS group is being deleted.
- **FREEZED**: indicates that the AS group has been frozen.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The ID of the list.

* `groups` - A list of AS groups.
* `groups` - A list of AS groups. The [groups](#as_groups) object structure is documented below.

<a name="as_groups"></a>
The `groups` block supports:

* `scaling_group_name` - The name of the AS group.
Expand All @@ -61,15 +62,15 @@ The `groups` block supports:
* `cool_down_time` - The cooling duration, in seconds..

* `lbaas_listeners` - The enhanced load balancers.
The [object](#lbaas_listener_object) structure is documented below.
The [lbaas_listeners](#as_lbaas_listener_object) structure is documented below.

* `availability_zones` - The AZ information.

* `networks` - The network information.
The [object](#network_object) structure is documented below.
The [networks](#as_network_object) structure is documented below.

* `security_groups` - The security group information.
The [object](#security_group_object) structure is documented below.
The [security_groups](#as_security_group_object) structure is documented below.

* `created_at` - The time when an AS group was created. The time format complies with UTC.

Expand Down Expand Up @@ -106,7 +107,7 @@ The `groups` block supports:

* `instances` - The scaling group instances ids.

<a name="lbaas_listener_object"></a>
<a name="as_lbaas_listener_object"></a>
The `lbaas_listeners` block supports:

* `pool_id` - The backend ECS group ID.
Expand All @@ -116,7 +117,7 @@ The `lbaas_listeners` block supports:
* `weight` - The weight, which determines the portion of requests a backend ECS processes
compared to other backend ECSs added to the same listener.

<a name="network_object"></a>
<a name="as_network_object"></a>
The `networks` block supports:

* `id` - The subnet ID.
Expand All @@ -127,7 +128,7 @@ The `networks` block supports:

* `source_dest_check` - Whether processesing only traffic that is destined specifically for it.

<a name="security_group_object"></a>
<a name="as_security_group_object"></a>
The `security_groups` block supports:

* `id` - The ID of the security group.

0 comments on commit 1607e0d

Please sign in to comment.