Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mikatong committed Dec 16, 2024
1 parent fd7a1b6 commit 89140ec
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func DataSourceTencentCloudElasticPublicIpv6s() *schema.Resource {
"ipv6_address_ids": {
Type: schema.TypeSet,
Optional: true,
Description: "Unique ID column that identifies IPv6.\n - Traditional Elastic IPv6 unique ID is like: `eip-11112222`\n - Elastic IPv6 unique ID is like: `eipv6 -11112222`\nNote: Parameters do not support specifying both IPv6AddressIds and Filters.",
Description: "Unique ID column that identifies IPv6.\n\t- Traditional Elastic IPv6 unique ID is like: `eip-11112222`\n\t- Elastic IPv6 unique ID is like: `eipv6 -11112222`\nNote: Parameters do not support specifying both IPv6AddressIds and Filters.",
Elem: &schema.Schema{
Type: schema.TypeString,
},
Expand All @@ -27,7 +27,7 @@ func DataSourceTencentCloudElasticPublicIpv6s() *schema.Resource {
"filters": {
Type: schema.TypeList,
Optional: true,
Description: "The detailed filter conditions are as follows:\n -address-id-String-required: no-(filter condition) filter by the unique ID of the elastic public network IPv6.\n -public-ipv6-address-String-required: no-(filter condition) filter by the IP address of the public network IPv6.\n -charge-type-String-required: no-(filter condition) filter by billing type.\n -private-ipv6-address-String-required: no-(filter condition) filter by bound private network IPv6 address.\n -egress-String-required: no-(filter condition) filter by exit.\n -address-type-String-required: no-(filter condition) filter by IPv6 type.\n -address-isp-String-required: no-(filter condition) filter by operator type.\n The status includes: 'CREATING','BINDING','BIND','UNBINDING','UNBIND','OFFLINING','BIND_ENI','PRIVATE'.\n -address-name-String-required: no-(filter condition) filter by EIP name. Blur filtering is not supported.\n -tag-key-String-required: no-(filter condition) filter by label key.\n -tag-value-String-required: no-(filter condition) filter by tag value.\n -tag:tag-key-String-required: no-(filter condition) filter by label key value pair. Tag-key is replaced with a specific label key.",
Description: "The detailed filter conditions are as follows:\n\t- address-id-String-required: no-(filter condition) filter by the unique ID of the elastic public network IPv6.\n\t- public-ipv6-address-String-required: no-(filter condition) filter by the IP address of the public network IPv6.\n\t- charge-type-String-required: no-(filter condition) filter by billing type.\n\t- private-ipv6-address-String-required: no-(filter condition) filter by bound private network IPv6 address.\n\t- egress-String-required: no-(filter condition) filter by exit.\n\t- address-type-String-required: no-(filter condition) filter by IPv6 type.\n\t- address-isp-String-required: no-(filter condition) filter by operator type.\n The status includes: 'CREATING','BINDING','BIND','UNBINDING','UNBIND','OFFLINING','BIND_ENI','PRIVATE'.\n\t- address-name-String-required: no-(filter condition) filter by EIP name. Blur filtering is not supported.\n\t- tag-key-String-required: no-(filter condition) filter by label key.\n\t- tag-value-String-required: no-(filter condition) filter by tag value.\n\t- tag:tag-key-String-required: no-(filter condition) filter by label key value pair. Tag-key is replaced with a specific label key.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down Expand Up @@ -206,7 +206,7 @@ func DataSourceTencentCloudElasticPublicIpv6s() *schema.Resource {
"renew_flag": {
Type: schema.TypeString,
Required: true,
Description: "Whether the current EIP is automatically renewed, this field will be displayed only for EIP prepaid by monthly bandwidth. Examples of specific values are as follows:\n - NOTIFY_AND_MANUAL_RENEW: Normal renewal\n - NOTIFY_AND_AUTO_RENEW: Automatic renewal\n - DISABLE_NOTIFY_AND_MANUAL_RENEW: No renewal after expiration.",
Description: "Whether the current EIP is automatically renewed, this field will be displayed only for EIP prepaid by monthly bandwidth. Examples of specific values are as follows:\n\t- NOTIFY_AND_MANUAL_RENEW: Normal renewal\n\t- NOTIFY_AND_AUTO_RENEW: Automatic renewal\n\t- DISABLE_NOTIFY_AND_MANUAL_RENEW: No renewal after expiration.",
},
"bandwidth_package_id": {
Type: schema.TypeString,
Expand Down
10 changes: 5 additions & 5 deletions tencentcloud/services/vpc/resource_tc_elastic_public_ipv6.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,28 @@ func ResourceTencentCloudElasticPublicIpv6() *schema.Resource {
Type: schema.TypeString,
Optional: true,
Computed: true,
Description: "Elastic IPv6 type, optional values:\n- EIPv6: Ordinary IPv6\n- HighQualityEIPv6: Premium IPv6\nNote: You need to contact the product to open a premium IPv6 white list, and only some regions support premium IPv6\nDefault value: EIPv6.",
Description: "Elastic IPv6 type, optional values:\n\t- EIPv6: Ordinary IPv6\n\t- HighQualityEIPv6: Premium IPv6\nNote: You need to contact the product to open a premium IPv6 white list, and only some regions support premium IPv6\nDefault value: EIPv6.",
},

"internet_charge_type": {
Type: schema.TypeString,
Optional: true,
Computed: true,
Description: "Elastic IPv6 charging method, optional values:\n- BANDWIDTH_PACKAGE: Payment for Shared Bandwidth Package\n- TRAFFIC_POSTPAID_BY_HOUR: Traffic is paid by the hour\nDefault value: TRAFFIC_POSTPAID_BY_HOUR.",
Description: "Elastic IPv6 charging method, optional values:\n\t- BANDWIDTH_PACKAGE: Payment for Shared Bandwidth Package\n\t- TRAFFIC_POSTPAID_BY_HOUR: Traffic is paid by the hour\nDefault value: TRAFFIC_POSTPAID_BY_HOUR.",
},

"internet_service_provider": {
Type: schema.TypeString,
Optional: true,
Computed: true,
Description: "Elastic IPv6 line type, default value: BGP.\nFor users who have activated a static single-line IP whitelist, selectable values:\n- CMCC: China Mobile\n- CTCC: China Telecom\n- CUCC: China Unicom\nNote: Static single-wire IP is only supported in some regions.",
Description: "Elastic IPv6 line type, default value: BGP.\nFor users who have activated a static single-line IP whitelist, selectable values:\n\t- CMCC: China Mobile\n\t- CTCC: China Telecom\n\t- CUCC: China Unicom\nNote: Static single-wire IP is only supported in some regions.",
},

"internet_max_bandwidth_out": {
Type: schema.TypeInt,
Optional: true,
Computed: true,
Description: "Elastic IPv6 bandwidth limit in Mbps.\nThe range of selectable values depends on the EIP billing method:\n- BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps\n- TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps\nDefault value: 1 Mbps.",
Description: "Elastic IPv6 bandwidth limit in Mbps.\nThe range of selectable values depends on the EIP billing method:\n\t- BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps\n\t- TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps\nDefault value: 1 Mbps.",
},

"bandwidth_package_id": {
Expand All @@ -77,7 +77,7 @@ func ResourceTencentCloudElasticPublicIpv6() *schema.Resource {
Type: schema.TypeString,
Optional: true,
Computed: true,
Description: "Elastic IPv6 network exit, optional values:\n- CENTER_EGRESS_1: Center Exit 1\n- CENTER_EGRESS_2: Center Exit 2\n- CENTER_EGRESS_3: Center Exit 3\nNote: Network exports corresponding to different operators or resource types need to contact the product for clarification\nDefault value: CENTER_EGRESS_1.",
Description: "Elastic IPv6 network exit, optional values:\n\t- CENTER_EGRESS_1: Center Exit 1\n\t- CENTER_EGRESS_2: Center Exit 2\n\t- CENTER_EGRESS_3: Center Exit 3\nNote: Network exports corresponding to different operators or resource types need to contact the product for clarification\nDefault value: CENTER_EGRESS_1.",
},

"address_ip": {
Expand Down
26 changes: 13 additions & 13 deletions website/docs/d/elastic_public_ipv6s.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ data "tencentcloud_elastic_public_ipv6s" "elastic_public_ipv6s" {
The following arguments are supported:

* `filters` - (Optional, List) The detailed filter conditions are as follows:
-address-id-String-required: no-(filter condition) filter by the unique ID of the elastic public network IPv6.
-public-ipv6-address-String-required: no-(filter condition) filter by the IP address of the public network IPv6.
-charge-type-String-required: no-(filter condition) filter by billing type.
-private-ipv6-address-String-required: no-(filter condition) filter by bound private network IPv6 address.
-egress-String-required: no-(filter condition) filter by exit.
-address-type-String-required: no-(filter condition) filter by IPv6 type.
-address-isp-String-required: no-(filter condition) filter by operator type.
- address-id-String-required: no-(filter condition) filter by the unique ID of the elastic public network IPv6.
- public-ipv6-address-String-required: no-(filter condition) filter by the IP address of the public network IPv6.
- charge-type-String-required: no-(filter condition) filter by billing type.
- private-ipv6-address-String-required: no-(filter condition) filter by bound private network IPv6 address.
- egress-String-required: no-(filter condition) filter by exit.
- address-type-String-required: no-(filter condition) filter by IPv6 type.
- address-isp-String-required: no-(filter condition) filter by operator type.
The status includes: 'CREATING','BINDING','BIND','UNBINDING','UNBIND','OFFLINING','BIND_ENI','PRIVATE'.
-address-name-String-required: no-(filter condition) filter by EIP name. Blur filtering is not supported.
-tag-key-String-required: no-(filter condition) filter by label key.
-tag-value-String-required: no-(filter condition) filter by tag value.
-tag:tag-key-String-required: no-(filter condition) filter by label key value pair. Tag-key is replaced with a specific label key.
- address-name-String-required: no-(filter condition) filter by EIP name. Blur filtering is not supported.
- tag-key-String-required: no-(filter condition) filter by label key.
- tag-value-String-required: no-(filter condition) filter by tag value.
- tag:tag-key-String-required: no-(filter condition) filter by label key value pair. Tag-key is replaced with a specific label key.
* `ipv6_address_ids` - (Optional, Set: [`String`]) Unique ID column that identifies IPv6.
- Traditional Elastic IPv6 unique ID is like: `eip-11112222`
- Elastic IPv6 unique ID is like: `eipv6 -11112222`
- Traditional Elastic IPv6 unique ID is like: `eip-11112222`
- Elastic IPv6 unique ID is like: `eipv6 -11112222`
Note: Parameters do not support specifying both IPv6AddressIds and Filters.
* `result_output_file` - (Optional, String) Used to save results.
* `traditional` - (Optional, Bool) Whether to query traditional IPv6 address information.
Expand Down
24 changes: 12 additions & 12 deletions website/docs/r/elastic_public_ipv6.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,31 +30,31 @@ The following arguments are supported:
* `address_ip` - (Optional, String) External network IP address.
* `address_name` - (Optional, String) EIP name, used to customize the personalized name of the EIP when applying for EIP. Default value: unnamed.
* `address_type` - (Optional, String) Elastic IPv6 type, optional values:
- EIPv6: Ordinary IPv6
- HighQualityEIPv6: Premium IPv6
- EIPv6: Ordinary IPv6
- HighQualityEIPv6: Premium IPv6
Note: You need to contact the product to open a premium IPv6 white list, and only some regions support premium IPv6
Default value: EIPv6.
* `bandwidth_package_id` - (Optional, String) Bandwidth packet unique ID parameter. If this parameter is set and the InternetChargeType is BANDWIDTH_PACKAGE, it means that the EIP created is added to the BGP bandwidth packet and the bandwidth packet is charged.
* `egress` - (Optional, String) Elastic IPv6 network exit, optional values:
- CENTER_EGRESS_1: Center Exit 1
- CENTER_EGRESS_2: Center Exit 2
- CENTER_EGRESS_3: Center Exit 3
- CENTER_EGRESS_1: Center Exit 1
- CENTER_EGRESS_2: Center Exit 2
- CENTER_EGRESS_3: Center Exit 3
Note: Network exports corresponding to different operators or resource types need to contact the product for clarification
Default value: CENTER_EGRESS_1.
* `internet_charge_type` - (Optional, String) Elastic IPv6 charging method, optional values:
- BANDWIDTH_PACKAGE: Payment for Shared Bandwidth Package
- TRAFFIC_POSTPAID_BY_HOUR: Traffic is paid by the hour
- BANDWIDTH_PACKAGE: Payment for Shared Bandwidth Package
- TRAFFIC_POSTPAID_BY_HOUR: Traffic is paid by the hour
Default value: TRAFFIC_POSTPAID_BY_HOUR.
* `internet_max_bandwidth_out` - (Optional, Int) Elastic IPv6 bandwidth limit in Mbps.
The range of selectable values depends on the EIP billing method:
- BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps
- TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps
- BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps
- TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps
Default value: 1 Mbps.
* `internet_service_provider` - (Optional, String) Elastic IPv6 line type, default value: BGP.
For users who have activated a static single-line IP whitelist, selectable values:
- CMCC: China Mobile
- CTCC: China Telecom
- CUCC: China Unicom
- CMCC: China Mobile
- CTCC: China Telecom
- CUCC: China Unicom
Note: Static single-wire IP is only supported in some regions.
* `tags` - (Optional, Map) Tags.

Expand Down

0 comments on commit 89140ec

Please sign in to comment.