Skip to content

Commit 55e607d

Browse files
crab21crab21
authored
Specification describe (#534)
update docs
1 parent e455cc2 commit 55e607d

File tree

184 files changed

+912
-492
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+912
-492
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
ENHANCEMENTS:
44

5+
* update Resource and Datasource description.
56
* Resource: `tencentcloud_kubernetes_cluster` add new argument `kube_config`.
67
* Resource: `tencentcloud_kubernetes_cluster` add value `tlinux2.4x86_64` with argument `cluster_os` to support linux OS system.
78
* Resource: `tencentcloud_kubernetes_cluster` add new argument `mount_target` to support set disk mount path.
89
* Resource: `tencentcloud_kubernetes_cluster` add new argument `docker_graph_path` to support set docker graph path.
910
* Resource: `tencentcloud_clb_redirection` add new argument `delete_all_auto_rewirte` to delete all auto-associated redirection when destroying the resource.
11+
* Resource: `tencentcloud_kubernetes_scale_worker` add new argument `labels` to support scale worker labels.
1012
* Data Source: `tencentcloud_kubernetes_clusters` add new argument `kube_config`.
1113
* Data Source: `tencentcloud_availability_regions` support getting local region info by setting argument `name` with value `default`.
12-
* Resource: `tencentcloud_kubernetes_scale_worker` add new argument `labels` to support scale worker labels.
1314

1415
BUG FIXES:
1516

‎tencentcloud/data_source_tc_cam_policies.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ func dataSourceTencentCloudCamPolicies() *schema.Resource {
5353
Type: schema.TypeInt,
5454
Optional: true,
5555
ValidateFunc: validateAllowedIntValue([]int{1, 2}),
56-
Description: "Type of the policy strategy. 1 means customer strategy and 2 means preset strategy.",
56+
Description: "Type of the policy strategy. Valid values: 1, 2. 1 means customer strategy and 2 means preset strategy.",
5757
},
5858
"create_mode": {
5959
Type: schema.TypeInt,
6060
Optional: true,
6161
ValidateFunc: validateAllowedIntValue([]int{1, 2}),
62-
Description: "Mode of creation of policy strategy. 1 means policy was created with console, and 2 means it was created by strategies.",
62+
Description: "Mode of creation of policy strategy. Valid values: 1, 2. 1 means policy was created with console, and 2 means it was created by strategies.",
6363
},
6464
"result_output_file": {
6565
Type: schema.TypeString,

‎tencentcloud/data_source_tc_cam_role_policy_attachments.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func dataSourceTencentCloudCamRolePolicyAttachments() *schema.Resource {
5454
Type: schema.TypeString,
5555
Optional: true,
5656
ValidateFunc: validateAllowedStringValue(CAM_POLICY_CREATE_STRATEGY),
57-
Description: "Type of the policy strategy. Valid values are 'User', 'QCS', '', 'User' means customer strategy and 'QCS' means preset strategy.",
57+
Description: "Type of the policy strategy. Valid values are 'User', 'QCS'. 'User' means customer strategy and 'QCS' means preset strategy.",
5858
},
5959
"result_output_file": {
6060
Type: schema.TypeString,

‎tencentcloud/data_source_tc_ccn_bandwidth_limits.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ func dataSourceTencentCloudCcnBandwidthLimits() *schema.Resource {
4949
Optional: true,
5050
Description: "Used to save results.",
5151
},
52-
5352
// Computed values
5453
"limits": {
5554
Type: schema.TypeList,

‎tencentcloud/data_source_tc_cdn_domains.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ func dataSourceTencentCloudCdnDomains() *schema.Resource {
4848
Type: schema.TypeString,
4949
Optional: true,
5050
ValidateFunc: validateAllowedStringValue(CDN_ORIGIN_PULL_PROTOCOL),
51-
Description: "Origin-pull protocol configuration. The available value include `http`, `https` and `follow`.",
51+
Description: "Origin-pull protocol configuration. Valid values: `http`, `https` and `follow`.",
5252
},
5353
"https_switch": {
5454
Type: schema.TypeString,
5555
Optional: true,
5656
ValidateFunc: validateAllowedStringValue(CDN_HTTPS_SWITCH),
57-
Description: "HTTPS configuration. The available value include `on`, `off` and `processing`.",
57+
Description: "HTTPS configuration. Valid values: `on`, `off` and `processing`.",
5858
},
5959
"result_output_file": {
6060
Type: schema.TypeString,

‎tencentcloud/data_source_tc_dc_gateway_instances.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,17 +88,17 @@ func dataSourceTencentCloudDcGatewayInstances() *schema.Resource {
8888
"network_instance_id": {
8989
Type: schema.TypeString,
9090
Computed: true,
91-
Description: "Type of associated network, the available value include 'VPC' and 'CCN'.",
91+
Description: "Type of associated network. Valid values: 'VPC' and 'CCN'.",
9292
},
9393
"gateway_type": {
9494
Type: schema.TypeString,
9595
Computed: true,
96-
Description: "Type of the gateway, the available value include 'NORMAL' and 'NAT'. Default is 'NORMAL'.",
96+
Description: "Type of the gateway. Valid values: 'NORMAL' and 'NAT'. Default is 'NORMAL'.",
9797
},
9898
"cnn_route_type": {
9999
Type: schema.TypeString,
100100
Computed: true,
101-
Description: "Type of CCN route, the available value include 'BGP' and 'STATIC'.",
101+
Description: "Type of CCN route. Valid values: 'BGP' and 'STATIC'.",
102102
},
103103
"enable_bgp": {
104104
Type: schema.TypeBool,

‎tencentcloud/data_source_tc_dcx_instances.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
6666
"network_type": {
6767
Type: schema.TypeString,
6868
Computed: true,
69-
Description: "Type of the network, and available values include VPC, BMVPC and CCN. The default value is VPC.",
69+
Description: "Type of the network. Valid values: VPC, BMVPC and CCN. The default value is VPC.",
7070
},
7171
"dcg_id": {
7272
Type: schema.TypeString,
@@ -91,7 +91,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
9191
"route_type": {
9292
Type: schema.TypeString,
9393
Computed: true,
94-
Description: "Type of the route, and available values include BGP and STATIC. The default value is BGP.",
94+
Description: "Type of the route. Valid values: BGP and STATIC. The default value is BGP.",
9595
},
9696
"bgp_asn": {
9797
Type: schema.TypeInt,
@@ -114,7 +114,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
114114
"vlan": {
115115
Type: schema.TypeInt,
116116
Computed: true,
117-
Description: "Vlan of the dedicated tunnels, and the range of values is [0-3000]. '0' means that only one tunnel can be created for the physical connect.",
117+
Description: "Vlan of the dedicated tunnels. Valid value ranges: [0-3000]. '0' means that only one tunnel can be created for the physical connect.",
118118
},
119119
"tencent_address": {
120120
Type: schema.TypeString,
@@ -134,7 +134,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
134134
"state": {
135135
Type: schema.TypeString,
136136
Computed: true,
137-
Description: "State of the dedicated tunnels, and available values include PENDING, ALLOCATING, ALLOCATED, ALTERING, DELETING, DELETED, COMFIRMING and REJECTED.",
137+
Description: "State of the dedicated tunnels. Valid values: PENDING, ALLOCATING, ALLOCATED, ALTERING, DELETING, DELETED, COMFIRMING and REJECTED.",
138138
},
139139
"create_time": {
140140
Type: schema.TypeString,

‎tencentcloud/data_source_tc_dnats.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ func dataSourceTencentCloudDnats() *schema.Resource {
102102
"protocol": {
103103
Type: schema.TypeString,
104104
Computed: true,
105-
Description: "Type of the network protocol, the available values include: `TCP` and `UDP`.",
105+
Description: "Type of the network protocol. Valid values: `TCP` and `UDP`.",
106106
},
107107
"elastic_ip": {
108108
Type: schema.TypeString,

‎tencentcloud/data_source_tc_gaap_certificates.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func dataSourceTencentCloudGaapCertificates() *schema.Resource {
4545
Type: schema.TypeString,
4646
Optional: true,
4747
ValidateFunc: validateAllowedStringValue([]string{"BASIC", "CLIENT", "SERVER", "REALSERVER", "PROXY"}),
48-
Description: "Type of the certificate to be queried, the available values include `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`; `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate.",
48+
Description: "Type of the certificate to be queried. Valid values: `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`. `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate.",
4949
},
5050
"result_output_file": {
5151
Type: schema.TypeString,

‎tencentcloud/data_source_tc_gaap_layer4_listeners.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func dataSourceTencentCloudGaapLayer4Listeners() *schema.Resource {
6161
Type: schema.TypeString,
6262
Required: true,
6363
ValidateFunc: validateAllowedStringValue([]string{"TCP", "UDP"}),
64-
Description: "Protocol of the layer4 listener to be queried, the available values include `TCP` and `UDP`.",
64+
Description: "Protocol of the layer4 listener to be queried. Valid values: `TCP` and `UDP`.",
6565
},
6666
"proxy_id": {
6767
Type: schema.TypeString,

‎tencentcloud/data_source_tc_gaap_layer7_listeners.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func dataSourceTencentCloudGaapLayer7Listeners() *schema.Resource {
4646
Type: schema.TypeString,
4747
Required: true,
4848
ValidateFunc: validateAllowedStringValue([]string{"HTTP", "HTTPS"}),
49-
Description: "Protocol of the layer7 listener to be queried, the available values include `HTTP` and `HTTPS`.",
49+
Description: "Protocol of the layer7 listener to be queried. Valid values: `HTTP` and `HTTPS`.",
5050
},
5151
"proxy_id": {
5252
Type: schema.TypeString,

‎tencentcloud/data_source_tc_ha_vips.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func dataSourceTencentCloudHaVips() *schema.Resource {
9898
"state": {
9999
Type: schema.TypeString,
100100
Computed: true,
101-
Description: "State of the HA VIP, values are `AVAILABLE`, `UNBIND`.",
101+
Description: "State of the HA VIP. Valid values: `AVAILABLE`, `UNBIND`.",
102102
},
103103
"instance_id": {
104104
Type: schema.TypeString,

‎tencentcloud/data_source_tc_images.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func dataSourceTencentCloudImages() *schema.Resource {
3939
Type: schema.TypeList,
4040
Optional: true,
4141
Elem: &schema.Schema{Type: schema.TypeString},
42-
Description: "A list of the image type to be queried. Available values include: 'PUBLIC_IMAGE', 'PRIVATE_IMAGE', 'SHARED_IMAGE', 'MARKET_IMAGE'.",
42+
Description: "A list of the image type to be queried. Valid values: 'PUBLIC_IMAGE', 'PRIVATE_IMAGE', 'SHARED_IMAGE', 'MARKET_IMAGE'.",
4343
},
4444
"image_name_regex": {
4545
Type: schema.TypeString,

‎tencentcloud/data_source_tc_instance_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func dataSourceInstanceTypes() *schema.Resource {
6060
"name": {
6161
Type: schema.TypeString,
6262
Required: true,
63-
Description: "The filter name, the available values include `zone` and `instance-family`.",
63+
Description: "The filter name. Valid values: `zone` and `instance-family`.",
6464
},
6565
"values": {
6666
Type: schema.TypeList,

‎tencentcloud/data_source_tc_nats.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func dataSourceTencentCloudNats() *schema.Resource {
6161
"state": {
6262
Type: schema.TypeInt,
6363
Optional: true,
64-
Description: "NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.",
64+
Description: "NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.",
6565
},
6666
"max_concurrent": {
6767
Type: schema.TypeInt,

‎tencentcloud/data_source_tc_sqlserver_zone_config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ func dataSourceTencentSqlserverZoneConfig() *schema.Resource {
9797
"charge_type": {
9898
Type: schema.TypeString,
9999
Computed: true,
100-
Description: "Billing mode under this specification. Valid values are `POSTPAID_BY_HOUR`, `PREPAID` and `ALL` which means both POSTPAID_BY_HOUR and PREPAID.",
100+
Description: "Billing mode under this specification. Valid values are `POSTPAID_BY_HOUR`, `PREPAID` and `ALL`. `ALL` means both POSTPAID_BY_HOUR and PREPAID.",
101101
},
102102
},
103103
},

‎tencentcloud/data_source_tc_tcaplus_clusters.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ func dataSourceTencentCloudTcaplusClusters() *schema.Resource {
9494
"password_status": {
9595
Type: schema.TypeString,
9696
Computed: true,
97-
Description: "Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, which means the password can not be changed in this moment; `modifiable`, which means the password can be changed in this moment.",
97+
Description: "Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, `modifiable`. `unmodifiable` means the password can not be changed in this moment; `modifiable` means the password can be changed in this moment.",
9898
},
9999
"api_access_id": {
100100
Type: schema.TypeString,

‎tencentcloud/data_source_tc_vod_adaptive_dynamic_streaming_templates.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
7676
"type": {
7777
Type: schema.TypeString,
7878
Optional: true,
79-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
79+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
8080
},
8181
"sub_app_id": {
8282
Type: schema.TypeInt,
@@ -102,7 +102,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
102102
"type": {
103103
Type: schema.TypeString,
104104
Computed: true,
105-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
105+
Description: "Template type filter. Valid values: `Preset`,`Custom`. `Preset`: preset template; `Custom`: custom template.",
106106
},
107107
"format": {
108108
Type: schema.TypeString,
@@ -149,7 +149,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
149149
"codec": {
150150
Type: schema.TypeString,
151151
Computed: true,
152-
Description: "Video stream encoder. Valid values: `libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4.",
152+
Description: "Video stream encoder. Valid values: `libx264`, `libx265`, `av1`.`libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4.",
153153
},
154154
"fps": {
155155
Type: schema.TypeInt,
@@ -164,7 +164,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
164164
"resolution_adaptive": {
165165
Type: schema.TypeBool,
166166
Computed: true,
167-
Description: "Resolution adaption. Valid values: `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Note: this field may return null, indicating that no valid values can be obtained.",
167+
Description: "Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Note: this field may return null, indicating that no valid values can be obtained.",
168168
},
169169
"width": {
170170
Type: schema.TypeInt,
@@ -203,7 +203,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
203203
"sample_rate": {
204204
Type: schema.TypeInt,
205205
Computed: true,
206-
Description: "Audio stream sample rate. Valid values: `32000`, `44100`, `48000`, in Hz.",
206+
Description: "Audio stream sample rate. Valid values: `32000`, `44100`, `48000`. Unit is HZ.",
207207
},
208208
"audio_channel": {
209209
Type: schema.TypeString,

‎tencentcloud/data_source_tc_vod_image_sprite_templates.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func dataSourceTencentCloudVodImageSpriteTemplates() *schema.Resource {
4747
"type": {
4848
Type: schema.TypeString,
4949
Optional: true,
50-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
50+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
5151
},
5252
"sub_app_id": {
5353
Type: schema.TypeInt,
@@ -73,12 +73,12 @@ func dataSourceTencentCloudVodImageSpriteTemplates() *schema.Resource {
7373
"type": {
7474
Type: schema.TypeString,
7575
Computed: true,
76-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
76+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
7777
},
7878
"sample_type": {
7979
Type: schema.TypeString,
8080
Computed: true,
81-
Description: "Sampling type. Valid values: `Percent`: by percent. `Time`: by time interval.",
81+
Description: "Sampling type. Valid values: `Percent`, `Time`. `Percent`: by percent. `Time`: by time interval.",
8282
},
8383
"sample_interval": {
8484
Type: schema.TypeInt,

‎tencentcloud/data_source_tc_vod_procedure_templates.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
5353
"type": {
5454
Type: schema.TypeString,
5555
Optional: true,
56-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
56+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
5757
},
5858
"sub_app_id": {
5959
Type: schema.TypeInt,
@@ -74,7 +74,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
7474
"type": {
7575
Type: schema.TypeString,
7676
Computed: true,
77-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
77+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
7878
},
7979
"name": {
8080
Type: schema.TypeString,
@@ -256,7 +256,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
256256
"position_type": {
257257
Type: schema.TypeString,
258258
Computed: true,
259-
Description: "Screen capturing mode. Valid values: `Time`: screen captures by time point, `Percent`: screen captures by percentage.",
259+
Description: "Screen capturing mode. Valid values: `Time`, `Percent`. `Time`: screen captures by time point, `Percent`: screen captures by percentage.",
260260
},
261261
"position_value": {
262262
Type: schema.TypeFloat,

‎tencentcloud/data_source_tc_vod_snapshot_by_time_offset_templates.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
4444
"type": {
4545
Type: schema.TypeString,
4646
Optional: true,
47-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
47+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
4848
},
4949
"sub_app_id": {
5050
Type: schema.TypeInt,
@@ -70,7 +70,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
7070
"type": {
7171
Type: schema.TypeString,
7272
Computed: true,
73-
Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
73+
Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
7474
},
7575
"name": {
7676
Type: schema.TypeString,
@@ -90,7 +90,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
9090
"resolution_adaptive": {
9191
Type: schema.TypeBool,
9292
Computed: true,
93-
Description: "Resolution adaption. Valid values: `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height.",
93+
Description: "Resolution adaption. Valid values: `true`, `false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height.",
9494
},
9595
"format": {
9696
Type: schema.TypeString,

0 commit comments

Comments
 (0)