From edfb60508855b3b2fe8c2ece6752d5cc938eab64 Mon Sep 17 00:00:00 2001 From: fernandoHuawei <2019229048@tju.edu.cn> Date: Fri, 22 Sep 2023 17:00:50 +0800 Subject: [PATCH] docs: fix docs of vpc_v1 --- docs/data-sources/vpc_peering_connection_v2.md | 3 +++ docs/data-sources/vpc_route_v2.md | 6 ++++++ docs/data-sources/vpc_subnet_ids_v1.md | 3 +++ docs/data-sources/vpc_subnet_v1.md | 3 +++ docs/data-sources/vpc_v1.md | 4 ++++ docs/resources/vpc_peering_connection_accepter_v2.md | 10 ++++++++++ docs/resources/vpc_peering_connection_v2.md | 10 ++++++++++ docs/resources/vpc_route_v2.md | 10 ++++++++++ docs/resources/vpc_subnet_v1.md | 10 ++++++++++ docs/resources/vpc_v1.md | 7 +++++++ 10 files changed, 66 insertions(+) diff --git a/docs/data-sources/vpc_peering_connection_v2.md b/docs/data-sources/vpc_peering_connection_v2.md index 76ad8688a..46899e603 100644 --- a/docs/data-sources/vpc_peering_connection_v2.md +++ b/docs/data-sources/vpc_peering_connection_v2.md @@ -39,6 +39,9 @@ The given filters must match exactly one VPC peering connection whose data will * `name` (Optional) - The name of the specific VPC Peering Connection to retrieve. +* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs. + If omitted, the region argument of the provider is used. + ## Attributes Reference All of the argument attributes are exported as result attributes. diff --git a/docs/data-sources/vpc_route_v2.md b/docs/data-sources/vpc_route_v2.md index 95c1109f5..7504a311d 100644 --- a/docs/data-sources/vpc_route_v2.md +++ b/docs/data-sources/vpc_route_v2.md @@ -42,6 +42,12 @@ route whose data will be exported as attributes. * `type` (Optional) - Route type for filtering. +* `nexthop` (Optional) - Specifies the next hop. If the route type is peering, enter the VPC peering connection ID. + Changing this creates a new Route. + +* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs. + If omitted, the region argument of the provider is used. + ## Attribute Reference All of the argument attributes are also exported as diff --git a/docs/data-sources/vpc_subnet_ids_v1.md b/docs/data-sources/vpc_subnet_ids_v1.md index c5556b862..c4dd0ba19 100644 --- a/docs/data-sources/vpc_subnet_ids_v1.md +++ b/docs/data-sources/vpc_subnet_ids_v1.md @@ -33,6 +33,9 @@ The following arguments are supported: * `vpc_id` (Required) - Specifies the VPC ID used as the query filter. +* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs. + If omitted, the region argument of the provider is used. + ## Attributes Reference The following attributes are exported: diff --git a/docs/data-sources/vpc_subnet_v1.md b/docs/data-sources/vpc_subnet_v1.md index 4633e54dc..c2e57eb88 100644 --- a/docs/data-sources/vpc_subnet_v1.md +++ b/docs/data-sources/vpc_subnet_v1.md @@ -42,6 +42,9 @@ subnet whose data will be exported as attributes. * `primary_dns` (Optional) - The IP address of DNS server 1 on the specific subnet. +* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs. + If omitted, the region argument of the provider is used. + * `secondary_dns` (Optional) - The IP address of DNS server 2 on the specific subnet. * `availability_zone` (Optional) - The availability zone (AZ) to which the subnet should belong. diff --git a/docs/data-sources/vpc_v1.md b/docs/data-sources/vpc_v1.md index 640210fa0..2030fd158 100644 --- a/docs/data-sources/vpc_v1.md +++ b/docs/data-sources/vpc_v1.md @@ -57,3 +57,7 @@ The following attributes are exported: * `shared` - Specifies whether the cross-tenant sharing is supported. * `region` - See Argument Reference above. + +* `routes.destination` - Specifies the destination network segment of a routex. + +* `routes.nexthop` - Specifies the next hop of a route. diff --git a/docs/resources/vpc_peering_connection_accepter_v2.md b/docs/resources/vpc_peering_connection_accepter_v2.md index 19aa01723..6e1c070ef 100644 --- a/docs/resources/vpc_peering_connection_accepter_v2.md +++ b/docs/resources/vpc_peering_connection_accepter_v2.md @@ -77,6 +77,9 @@ The following arguments are supported: * `accept` (Optional)- Whether or not to accept the peering request. Defaults to `false`. +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the vpc subnet. If omitted, the + provider-level region will be used. Changing this creates a new subnet. + ## Removing flexibleengine_vpc_peering_connection_accepter_v2 from your configuration FlexibleEngine allows a cross-tenant VPC Peering Connection to be deleted from either the requester's or accepter's side. @@ -102,6 +105,13 @@ All of the argument attributes except accept are also exported as result attribu * `peer_tenant_id` - The Tenant Id of the accepter tenant. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. + ## Import VPC Peering Connection Accepter can be imported using the VPC Peering Connection ID `vpc_peering_connection_id`, e.g. diff --git a/docs/resources/vpc_peering_connection_v2.md b/docs/resources/vpc_peering_connection_v2.md index ebf0444f5..ed0718de9 100644 --- a/docs/resources/vpc_peering_connection_v2.md +++ b/docs/resources/vpc_peering_connection_v2.md @@ -43,6 +43,9 @@ The following arguments are supported: * `peer_vpc_id` (Required) - Specifies the VPC ID of the accepter tenant. Changing this creates a new VPC peering connection. * `peer_tenant_id` (Optional) - Specified the Tenant Id of the accepter tenant. Changing this creates a new VPC peering connection. + +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the vpc subnet. If omitted, the + provider-level region will be used. Changing this creates a new subnet. ## Attributes Reference @@ -53,6 +56,13 @@ result attributes: * `status` - The VPC peering connection status. The value can be PENDING_ACCEPTANCE, REJECTED, EXPIRED, DELETED, or ACTIVE. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. + ## Import VPC Peering resources can be imported using the `vpc peering id`, e.g. diff --git a/docs/resources/vpc_route_v2.md b/docs/resources/vpc_route_v2.md index 7cdf357b7..9fb34e60c 100644 --- a/docs/resources/vpc_route_v2.md +++ b/docs/resources/vpc_route_v2.md @@ -25,6 +25,9 @@ resource "flexibleengine_vpc_route_v2" "vpc_route" { The following arguments are supported: +* `region` - (Optional, String, ForceNew) The region in which to create the vpc route table. + If omitted, the provider-level region will be used. Changing this creates a new resource. + * `destination` (Required) - Specifies the destination IP address or CIDR block. Changing this creates a new Route. * `nexthop` (Required) - Specifies the next hop. If the route type is peering, enter the VPC peering connection ID. @@ -44,3 +47,10 @@ All of the argument attributes are also exported as result attributes: * `id` - The route ID. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. diff --git a/docs/resources/vpc_subnet_v1.md b/docs/resources/vpc_subnet_v1.md index ce58c9f7e..9dc70dee7 100644 --- a/docs/resources/vpc_subnet_v1.md +++ b/docs/resources/vpc_subnet_v1.md @@ -75,6 +75,9 @@ The following arguments are supported: * `tags` - (Optional, Map) The key/value pairs to associate with the subnet. +* `description` (Optional, String) - Provides supplementary information about the subnet. + The value can contain no more than 255 characters and cannot contain angle brackets (< or >). + ## Attributes Reference In addition to all arguments above, the following attributes are exported: @@ -91,6 +94,13 @@ In addition to all arguments above, the following attributes are exported: * `ipv6_gateway` - The IPv6 subnet gateway. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 5 minute. +* `delete` - Default is 5 minute. + ## Import Subnets can be imported using the VPC subnet ID, e.g. diff --git a/docs/resources/vpc_v1.md b/docs/resources/vpc_v1.md index 10007fa54..43214d369 100644 --- a/docs/resources/vpc_v1.md +++ b/docs/resources/vpc_v1.md @@ -59,6 +59,13 @@ In addition to all arguments above, the following attributes are exported: * `status` - The current status of the VPC. Possible values are as follows: CREATING, OK or ERROR. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 3 minute. + ## Import VPCs can be imported using the `id`, e.g.