Skip to content

Commit

Permalink
docs: fix docs of vpc_v1
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhukun-Huawei committed Sep 26, 2023
1 parent 07e6b32 commit 3ad0ca0
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/data-sources/vpc_route_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/vpc_subnet_ids_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/vpc_subnet_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/vpc_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 10 additions & 0 deletions docs/resources/vpc_route_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
10 changes: 10 additions & 0 deletions docs/resources/vpc_subnet_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/resources/vpc_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3ad0ca0

Please sign in to comment.