Skip to content

Commit

Permalink
feat: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
msq177 committed Apr 26, 2023
1 parent 5a09fdc commit f074c12
Show file tree
Hide file tree
Showing 26 changed files with 73 additions and 15 deletions.
2 changes: 1 addition & 1 deletion common/common_volcengine_version.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ package common

const (
TerraformProviderName = "terraform-provider-volcengine"
TerraformProviderVersion = "0.0.71"
TerraformProviderVersion = "0.0.72"
)
2 changes: 1 addition & 1 deletion website/docs/d/rds_accounts.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds accounts
---
# volcengine_rds_accounts
Use this data source to query detailed information of rds accounts
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds accounts
## Example Usage
```hcl
data "volcengine_rds_accounts" "default" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/rds_databases.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds databases
---
# volcengine_rds_databases
Use this data source to query detailed information of rds databases
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds databases
## Example Usage
```hcl
data "volcengine_rds_databases" "default" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/rds_instances.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds instances
---
# volcengine_rds_instances
Use this data source to query detailed information of rds instances
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds instances
## Example Usage
```hcl
data "volcengine_rds_instances" "default" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/rds_instances_v2.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds instances v2
---
# volcengine_rds_instances_v2
Use this data source to query detailed information of rds instances v2
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds instances v2
## Example Usage
```hcl
data "volcengine_rds_instances_v2" "default" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/rds_ip_lists.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds ip lists
---
# volcengine_rds_ip_lists
Use this data source to query detailed information of rds ip lists
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds ip lists
## Example Usage
```hcl
data "volcengine_rds_ip_lists" "default" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/rds_parameter_templates.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Use this data source to query detailed information of rds parameter templates
---
# volcengine_rds_parameter_templates
Use this data source to query detailed information of rds parameter templates
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds parameter templates
## Example Usage
```hcl
data "volcengine_rds_parameter_templates" "default" {
Expand Down
7 changes: 7 additions & 0 deletions website/docs/d/vpn_connections.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ In addition to all arguments above, the following attributes are exported:
* `account_id` - The account ID of the VPN connection.
* `attach_status` - The IPsec attach status.
* `attach_type` - The IPsec attach type.
* `business_status` - The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
* `connect_status` - The connect status of the VPN connection.
* `creation_time` - The create time of VPN connection.
* `customer_gateway_id` - The ID of the customer gateway.
* `deleted_time` - The delete time of resource, valid when the attach type is 'TransitRouter'.
* `description` - The description of the VPN connection.
* `dpd_action` - The dpd action of the VPN connection.
* `id` - The ID of the VPN connection.
Expand All @@ -45,18 +47,23 @@ In addition to all arguments above, the following attributes are exported:
* `ike_config_psk` - The psk of the ike config of the VPN connection.
* `ike_config_remote_id` - The remote id of the ike config of the VPN connection.
* `ike_config_version` - The version of the ike config of the VPN connection.
* `ip_address` - The ip address of transit router, valid when the attach type is 'TransitRouter'.
* `ipsec_config_auth_alg` - The auth alg of the ipsec config of the VPN connection.
* `ipsec_config_dh_group` - The dh group of the ipsec config of the VPN connection.
* `ipsec_config_enc_alg` - The enc alg of the ipsec config of the VPN connection.
* `ipsec_config_lifetime` - The lifetime of the ike config of the VPN connection.
* `local_subnet` - The local subnet of the VPN connection.
* `log_enabled` - Whether to enable the connection log.
* `nat_traversal` - The nat traversal of the VPN connection.
* `negotiate_instantly` - Whether to initiate negotiation mode immediately.
* `overdue_time` - The overdue time of resource, valid when the attach type is 'TransitRouter'.
* `remote_subnet` - The remote subnet of the VPN connection.
* `status` - The status of the VPN connection.
* `transit_router_id` - The id of transit router, valid when the attach type is 'TransitRouter'.
* `update_time` - The update time of VPN connection.
* `vpn_connection_id` - The ID of the VPN connection.
* `vpn_connection_name` - The name of the VPN connection.
* `vpn_gateway_id` - The ID of the vpn gateway.
* `zone_id` - The zone id of transit router, valid when the attach type is 'TransitRouter'.


4 changes: 4 additions & 0 deletions website/docs/r/cen_bandwidth_package.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_cen_bandwidth_package
Provides a resource to manage cen bandwidth package
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_cen_bandwidth_package" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/clb.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_clb
Provides a resource to manage clb
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_clb" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/ecs_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_ecs_instance
Provides a resource to manage ecs instance
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_vpc" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/eip_address.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_eip_address
Provides a resource to manage eip address
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_eip_address" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/mongodb_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_mongodb_instance
Provides a resource to manage mongodb instance
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_mongodb_instance" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/nat_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_nat_gateway
Provides a resource to manage nat gateway
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_nat_gateway" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds account
---
# volcengine_rds_account
Provides a resource to manage rds account
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds account
## Example Usage
```hcl
resource "volcengine_rds_account" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_account_privilege.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds account privilege
---
# volcengine_rds_account_privilege
Provides a resource to manage rds account privilege
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds account privilege
## Example Usage
```hcl
resource "volcengine_rds_account" "app_name" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_database.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds database
---
# volcengine_rds_database
Provides a resource to manage rds database
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds database
## Example Usage
```hcl
resource "volcengine_rds_database" "foo" {
Expand Down
6 changes: 5 additions & 1 deletion website/docs/r/rds_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ description: |-
Provides a resource to manage rds instance
---
# volcengine_rds_instance
Provides a resource to manage rds instance
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds instance
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_rds_instance" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_instance_v2.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds instance v2
---
# volcengine_rds_instance_v2
Provides a resource to manage rds instance v2
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds instance v2
## Example Usage
```hcl
resource "volcengine_rds_instance_v2" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_ip_list.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds ip list
---
# volcengine_rds_ip_list
Provides a resource to manage rds ip list
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds ip list
## Example Usage
```hcl
resource "volcengine_rds_ip_list" "foo" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/rds_parameter_template.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |-
Provides a resource to manage rds parameter template
---
# volcengine_rds_parameter_template
Provides a resource to manage rds parameter template
(Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds parameter template
## Example Usage
```hcl
resource "volcengine_rds_parameter_template" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/scaling_configuration.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_scaling_configuration
Provides a resource to manage scaling configuration
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_scaling_configuration" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/volume.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_volume
Provides a resource to manage volume
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_volume" "foo" {
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/vpc_ipv6_address_bandwidth.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_vpc_ipv6_address_bandwidth
Provides a resource to manage vpc ipv6 address bandwidth
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
data "volcengine_ecs_instances" "dataEcs" {
Expand Down
9 changes: 8 additions & 1 deletion website/docs/r/vpn_connection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ The following arguments are supported:
* `ike_config_psk` - (Required) The psk of the ike config of the VPN connection.
* `local_subnet` - (Required) The local subnet of the VPN connection.
* `remote_subnet` - (Required) The remote subnet of the VPN connection.
* `vpn_gateway_id` - (Required, ForceNew) The ID of the vpn gateway.
* `attach_type` - (Optional, ForceNew) The attach type of the VPN connection, the value can be VpnGateway or TransitRouter.
* `description` - (Optional) The description of the VPN connection.
* `dpd_action` - (Optional) The dpd action of the VPN connection.
Expand All @@ -61,17 +60,25 @@ The following arguments are supported:
* `negotiate_instantly` - (Optional) Whether to initiate negotiation mode immediately.
* `project_name` - (Optional) The project name of the VPN connection.
* `vpn_connection_name` - (Optional) The name of the VPN connection.
* `vpn_gateway_id` - (Optional, ForceNew) The ID of the vpn gateway.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `id` - ID of the resource.
* `account_id` - The account ID of the VPN connection.
* `attach_status` - The IPsec attach status.
* `business_status` - The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
* `connect_status` - The connect status of the VPN connection.
* `creation_time` - The create time of VPN connection.
* `deleted_time` - The delete time of resource, valid when the attach type is 'TransitRouter'.
* `ip_address` - The ip address of transit router, valid when the attach type is 'TransitRouter'.
* `log_enabled` - Whether to enable the connection log.
* `overdue_time` - The overdue time of resource, valid when the attach type is 'TransitRouter'.
* `status` - The status of the VPN connection.
* `transit_router_id` - The id of transit router, valid when the attach type is 'TransitRouter'.
* `update_time` - The update time of VPN connection.
* `vpn_connection_id` - The ID of the VPN connection.
* `zone_id` - The zone id of transit router, valid when the attach type is 'TransitRouter'.


## Import
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/vpn_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ description: |-
---
# volcengine_vpn_gateway
Provides a resource to manage vpn gateway
## Notice
When Destroy this resource,If the resource charge type is PrePaid,Please unsubscribe the resource
in [Volcengine Console](https://console.volcengine.com/finance/unsubscribe/),when complete console operation,yon can
use 'terraform state rm ${resourceId}' to remove.
## Example Usage
```hcl
resource "volcengine_vpn_gateway" "foo" {
Expand Down

0 comments on commit f074c12

Please sign in to comment.