Skip to content

Commit

Permalink
resource doc add id attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverpei committed Apr 8, 2020
1 parent e3d3667 commit d5d541d
Show file tree
Hide file tree
Showing 103 changed files with 334 additions and 0 deletions.
4 changes: 4 additions & 0 deletions gendoc/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,10 @@ func genDoc(dtype, fpath, name string, resource *schema.Resource) {
data["arguments"] += "\n" + strings.Join(subStruct, "\n")
}
data["attributes"] = strings.Join(attributes, "\n")
if dtype == "resource" {
idAttribute := "* `id` - ID of the resource.\n"
data["attributes"] = idAttribute + data["attributes"]
}

filename = filepath.Join(docRoot, dtype[:1], fmt.Sprintf("%s.html.markdown", data["resource"]))

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/alb_server_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ The `backends` object supports the following:

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

* `id` - ID of the resource.
* `protocol_type` - The protocol type, http or tcp.


7 changes: 7 additions & 0 deletions website/docs/r/as_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,11 @@ The following arguments are supported:
* `instance_ids` - (Required) ID list of CVM instances to be attached to the scaling group.
* `scaling_group_id` - (Required, ForceNew) ID of a scaling group.

## Attributes Reference

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

* `id` - ID of the resource.



7 changes: 7 additions & 0 deletions website/docs/r/as_lifecycle_hook.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,11 @@ The following arguments are supported:
* `notification_target_type` - (Optional) Target type, which can be CMQ_QUEUE or CMQ_TOPIC.
* `notification_topic_name` - (Optional) For CMQ_TOPIC type, a name of topic must be set.

## Attributes Reference

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

* `id` - ID of the resource.



7 changes: 7 additions & 0 deletions website/docs/r/as_notification.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,11 @@ The following arguments are supported:
* `notification_user_group_ids` - (Required) A group of user IDs to be notified.
* `scaling_group_id` - (Required, ForceNew) ID of a scaling group.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/as_scaling_config.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ The `data_disk` object supports the following:

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

* `id` - ID of the resource.
* `create_time` - The time when the launch configuration was created.
* `status` - Current statues of a launch configuration.

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/as_scaling_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ The `target_attribute` object supports the following:

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

* `id` - ID of the resource.
* `create_time` - The time when the AS group was created.
* `instance_count` - Instance number of a scaling group.
* `status` - Current status of a scaling group.
Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/as_scaling_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,11 @@ The following arguments are supported:
* `notification_user_group_ids` - (Optional) An ID group of users to be notified when an alarm is triggered.
* `statistic` - (Optional) Statistic types, include AVERAGE, MAXIMUM and MINIMUM. Default is AVERAGE.

## Attributes Reference

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

* `id` - ID of the resource.



7 changes: 7 additions & 0 deletions website/docs/r/as_schedule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,11 @@ The following arguments are supported:
* `end_time` - (Optional) The time for this action to end, in "YYYY-MM-DDThh:mm:ss+08:00" format (UTC+8).
* `recurrence` - (Optional) The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. And this argument should be set with end_time together.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/cam_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Create time of the CAM group.


Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cam_group_membership.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ The following arguments are supported:
* `group_id` - (Required) Id of CAM group.
* `user_ids` - (Required) Id set of the CAM group members.

## Attributes Reference

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

* `id` - ID of the resource.



## Import

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_group_policy_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_mode` - Mode of Creation of the CAM group policy attachment. 1 means the cam policy attachment is created by production, and the others indicate syntax strategy ways.
* `create_time` - Create time of the CAM group policy attachment.
* `policy_name` - Name of the policy.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Create time of the CAM policy.
* `type` - Type of the policy strategy. 1 means customer strategy and 2 means preset strategy.
* `update_time` - The last update time of the CAM policy.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_role.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Create time of the CAM role.
* `update_time` - The last update time of the CAM role.

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_role_policy_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_mode` - Mode of Creation of the CAM role policy attachment. 1 means the CAM policy attachment is created by production, and the others indicate syntax strategy ways.
* `create_time` - The create time of the CAM role policy attachment.
* `policy_name` - The name of the policy.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_saml_provider.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - The create time of the CAM SAML provider.
* `provider_arn` - The arn of the CAM SAML provider.
* `update_time` - The last update time of the CAM SAML provider.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_user.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `secret_id` - Secret ID of the CAM user.
* `secret_key` - Secret key of the CAM user.
* `uid` - ID of the CAM user.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cam_user_policy_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_mode` - Mode of Creation of the CAM user policy attachment. 1 means the CAM policy attachment is created by production, and the others indicate syntax strategy ways.
* `create_time` - Create time of the CAM user policy attachment.
* `policy_name` - Name of the policy.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cbs_snapshot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Creation time of snapshot.
* `disk_type` - Types of CBS which this snapshot created from.
* `percent` - Snapshot creation progress percentage. If the snapshot has created successfully, the constant value is 100.
Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cbs_snapshot_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ The following arguments are supported:
* `snapshot_policy_name` - (Required) Name of snapshot policy. The maximum length can not exceed 60 bytes.
* `retention_days` - (Optional) Retention days of the snapshot, and the default value is 7.

## Attributes Reference

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

* `id` - ID of the resource.



## Import

Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cbs_snapshot_policy_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,11 @@ The following arguments are supported:
* `snapshot_policy_id` - (Required, ForceNew) ID of CBS snapshot policy.
* `storage_id` - (Required, ForceNew) ID of CBS.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/cbs_storage.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `attached` - Indicates whether the CBS is mounted the CVM.
* `storage_status` - Status of CBS, and available values include UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.

Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cbs_storage_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,11 @@ The following arguments are supported:
* `instance_id` - (Required, ForceNew) ID of the CVM instance.
* `storage_id` - (Required, ForceNew) ID of the mounted CBS.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/ccn.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Creation time of resource.
* `instance_count` - Number of attached instances.
* `state` - States of instance. The available value include 'ISOLATED'(arrears) and 'AVAILABLE'.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/ccn_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `attached_time` - Time of attaching.
* `cidr_block` - A network address block of the instance that is attached.
* `state` - States of instance is attached, and available values include PENDING, ACTIVE, EXPIRED, REJECTED, DELETED, FAILED(asynchronous forced disassociation after 2 hours), ATTACHING, DETACHING and DETACHFAILED(asynchronous forced disassociation after 2 hours).
Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/ccn_bandwidth_limit.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,11 @@ The following arguments are supported:
* `region` - (Required, ForceNew) Limitation of region.
* `bandwidth_limit` - (Optional) Limitation of bandwidth.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/cdn_domain.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ The `server_certificate_config` object supports the following:

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

* `id` - ID of the resource.
* `create_time` - Creation time of domain name.
* `status` - Acceleration service status.

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/cfs_access_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Create time of the access group.


Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cfs_access_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,11 @@ The following arguments are supported:
* `rw_permission` - (Optional) Read and write permissions. Valid values are `RO` and `RW`, and default is `RO`.
* `user_permission` - (Optional) The permissions of accessing users. Valid values are `all_squash`, `no_all_squash`, `root_squash` and `no_root_squash`, and default is `root_squash`. `all_squash` indicates that all access users are mapped as anonymous users or user groups; `no_all_squash` indicates that access users will match local users first and be mapped to anonymous users or user groups after matching failed; `root_squash` indicates that map access root users to anonymous users or user groups; `no_root_squash` indicates that access root users keep root account permission.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/cfs_file_system.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `create_time` - Create time of the file system.


Expand Down
1 change: 1 addition & 0 deletions website/docs/r/clb_attachment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The `targets` object supports the following:

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

* `id` - ID of the resource.
* `protocol_type` - Type of protocol within the listener.


Expand Down
1 change: 1 addition & 0 deletions website/docs/r/clb_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `clb_vips` - The virtual service address table of the CLB.


Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/clb_listener.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,11 @@ The following arguments are supported:
* `session_expire_time` - (Optional) Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR', and not available when listener protocol is 'TCP_SSL'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
* `sni_switch` - (Optional, ForceNew) Indicates whether SNI is enabled, and only supported with protocol 'HTTPS'. If enabled, you can set a certificate for each rule in `tencentcloud_clb_listener_rule`, otherwise all rules have a certificate.

## Attributes Reference

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

* `id` - ID of the resource.



7 changes: 7 additions & 0 deletions website/docs/r/clb_listener_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,11 @@ The following arguments are supported:
* `scheduler` - (Optional) Scheduling method of the CLB listener rules, and available values are 'WRR', 'IP HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
* `session_expire_time` - (Optional) Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR', and not available when listener protocol is 'TCP_SSL'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.

## Attributes Reference

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

* `id` - ID of the resource.



7 changes: 7 additions & 0 deletions website/docs/r/clb_redirection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ The following arguments are supported:
* `source_listener_id` - (Optional, ForceNew) Id of source listener.
* `source_rule_id` - (Optional, ForceNew) Rule id of source listener.

## Attributes Reference

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

* `id` - ID of the resource.



## Import

Expand Down
1 change: 1 addition & 0 deletions website/docs/r/container_cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `kubernetes_version` - The kubernetes version of the cluster.
* `nodes_num` - The node number of the cluster.
* `nodes_status` - The node status of the cluster.
Expand Down
1 change: 1 addition & 0 deletions website/docs/r/container_cluster_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ The following arguments are supported:

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

* `id` - ID of the resource.
* `abnormal_reason` - Describe the reason when node is in abnormal state(if it was).
* `instance_id` - An id identify the node, provided by cvm.
* `is_normal` - Describe whether the node is normal.
Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cos_bucket.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,13 @@ The `website` object supports the following:
* `error_document` - (Optional) An absolute path to the document to return in case of a 4XX error.
* `index_document` - (Optional) COS returns this index document when requests are made to the root domain or any of the subfolders.

## Attributes Reference

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

* `id` - ID of the resource.



## Import

Expand Down
7 changes: 7 additions & 0 deletions website/docs/r/cos_bucket_object.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,11 @@ The following arguments are supported:
* `source` - (Optional) The path to the source file being uploaded to the bucket.
* `storage_class` - (Optional) Object storage type, Available values include STANDARD, STANDARD_IA and ARCHIVE.

## Attributes Reference

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

* `id` - ID of the resource.



1 change: 1 addition & 0 deletions website/docs/r/dayu_cc_http_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ The `rule_list` object supports the following:

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

* `id` - ID of the resource.
* `create_time` - Create time of the CC self-define http policy.
* `policy_id` - Id of the CC self-define http policy.

Expand Down
Loading

0 comments on commit d5d541d

Please sign in to comment.