From 53210b489e2eb6e130ab848acc2a326ada8a6ddd Mon Sep 17 00:00:00 2001 From: Zhukun-Huawei <145660317+Zhukun-Huawei@users.noreply.github.com> Date: Fri, 1 Dec 2023 17:14:31 +0800 Subject: [PATCH] docs(vpc): fix docs of vpc service (#1021) --- docs/data-sources/networking_port.md | 6 +-- .../data-sources/vpc_peering_connection_v2.md | 18 ++++++--- docs/data-sources/vpc_route_ids_v2.md | 5 ++- docs/data-sources/vpc_route_v2.md | 13 ++++--- docs/data-sources/vpc_subnet_ids_v1.md | 7 +++- docs/data-sources/vpc_subnet_v1.md | 23 ++++++----- docs/data-sources/vpc_v1.md | 4 ++ docs/data-sources/vpcep_endpoints.md | 3 ++ docs/data-sources/vpcep_public_services.md | 5 ++- docs/resources/networking_secgroup_rule_v2.md | 28 +++++++++----- docs/resources/networking_secgroup_v2.md | 16 ++++++-- docs/resources/vpc_flow_log_v1.md | 9 ++++- .../vpc_peering_connection_accepter_v2.md | 18 +++++++-- docs/resources/vpc_peering_connection_v2.md | 22 ++++++++--- docs/resources/vpc_route_v2.md | 23 ++++++++--- docs/resources/vpc_subnet_v1.md | 10 +++++ docs/resources/vpc_v1.md | 7 ++++ docs/resources/vpcep_approval.md | 11 +++--- docs/resources/vpcep_endpoint.md | 30 +++++++++------ docs/resources/vpcep_service.md | 38 +++++++++++-------- 20 files changed, 209 insertions(+), 87 deletions(-) diff --git a/docs/data-sources/networking_port.md b/docs/data-sources/networking_port.md index 0b35608b1..48696ac68 100644 --- a/docs/data-sources/networking_port.md +++ b/docs/data-sources/networking_port.md @@ -4,7 +4,7 @@ subcategory: "Virtual Private Cloud (VPC)" # flexibleengine_networking_port -Use this data source to get the ID of an available Flexibleengine port. +Use this data source to get the ID of an available FlexibleEngine port. ## Example Usage @@ -40,12 +40,12 @@ In addition to all arguments above, the following attributes are exported: * `name` - The name of the port. -* `admin_state_up` - The administrative state of the port. - * `device_owner` - The device owner of the port. * `device_id` - The ID of the device the port belongs to. +* `all_allowed_ips` - The collection of allowed IP addresses on the port. + * `all_fixed_ips` - The collection of Fixed IP addresses on the port. * `all_security_group_ids` - The collection of security group IDs applied on the port. diff --git a/docs/data-sources/vpc_peering_connection_v2.md b/docs/data-sources/vpc_peering_connection_v2.md index 76ad8688a..4d63b2b18 100644 --- a/docs/data-sources/vpc_peering_connection_v2.md +++ b/docs/data-sources/vpc_peering_connection_v2.md @@ -27,18 +27,24 @@ resource "flexibleengine_vpc_route_v2" "vpc_route" { The arguments of this data source act as filters for querying the available VPC peering connection. The given filters must match exactly one VPC peering connection whose data will be exported as attributes. -* `id` (Optional) - The ID of the specific VPC Peering Connection to retrieve. +* `region` - (Optional, String) 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. -* `status` (Optional) - The status of the specific VPC Peering Connection to retrieve. +* `id` (Optional, String) - The ID of the specific VPC Peering Connection to retrieve. -* `vpc_id` (Optional) - The ID of the requester VPC of the specific VPC Peering Connection to retrieve. +* `name` (Optional, String) - The name of the specific VPC Peering Connection to retrieve. -* `peer_vpc_id` (Optional) - The ID of the accepter/peer VPC of the specific VPC Peering Connection to retrieve. +* `status` (Optional, String) - The status of the specific VPC Peering Connection to retrieve. -* `peer_tenant_id` (Optional) - The Tenant ID of the accepter/peer VPC of the specific VPC Peering Connection to retrieve. +* `vpc_id` (Optional, String) - The ID of the requester VPC of the specific VPC Peering Connection to retrieve. -* `name` (Optional) - The name of the specific VPC Peering Connection to retrieve. +* `peer_vpc_id` (Optional, String) - The ID of the accepter/peer VPC of the specific VPC Peering Connection to retrieve. + +* `peer_tenant_id` (Optional, String) - The Tenant ID of the accepter/peer VPC + of the specific VPC Peering Connection to retrieve. ## Attributes Reference +* `description` - The description of the VPC Peering Connection. + All of the argument attributes are exported as result attributes. diff --git a/docs/data-sources/vpc_route_ids_v2.md b/docs/data-sources/vpc_route_ids_v2.md index 73c7b40ea..3ec6899d3 100644 --- a/docs/data-sources/vpc_route_ids_v2.md +++ b/docs/data-sources/vpc_route_ids_v2.md @@ -31,7 +31,10 @@ output "route_nexthop" { ## Argument Reference -* `vpc_id` (Required) - The VPC ID that you want to filter from. +* `region` - (Optional, String) 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. + +* `vpc_id` (Required, String) - The VPC ID that you want to filter from. ## Attributes Reference diff --git a/docs/data-sources/vpc_route_v2.md b/docs/data-sources/vpc_route_v2.md index 95c1109f5..e02f3a2ef 100644 --- a/docs/data-sources/vpc_route_v2.md +++ b/docs/data-sources/vpc_route_v2.md @@ -32,15 +32,18 @@ The arguments of this data source act as filters for querying the available routes in the current tenant. The given filters must match exactly one route whose data will be exported as attributes. -* `id` (Optional) - The id of the specific route to retrieve. +* `region` - (Optional, String) 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. -* `vpc_id` (Optional) - The id of the VPC that the desired route belongs to. +* `id` (Optional, String) - The id of the specific route to retrieve. -* `destination` (Optional) - The route destination address (CIDR). +* `vpc_id` (Optional, String) - The id of the VPC that the desired route belongs to. -* `tenant_id` (Optional) - Only the administrator can specify the tenant ID of other tenants. +* `destination` (Optional, String) - The route destination address (CIDR). -* `type` (Optional) - Route type for filtering. +* `tenant_id` (Optional, String) - Only the administrator can specify the tenant ID of other tenants. + +* `type` (Optional, String) - Route type for filtering. ## Attribute Reference diff --git a/docs/data-sources/vpc_subnet_ids_v1.md b/docs/data-sources/vpc_subnet_ids_v1.md index c5556b862..de3d65a11 100644 --- a/docs/data-sources/vpc_subnet_ids_v1.md +++ b/docs/data-sources/vpc_subnet_ids_v1.md @@ -31,10 +31,15 @@ output "subnet_cidr_blocks" { The following arguments are supported: -* `vpc_id` (Required) - Specifies the VPC ID used as the query filter. +* `region` - (Optional, String) 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. + +* `vpc_id` (Required, String) - Specifies the VPC ID used as the query filter. ## Attributes Reference The following attributes are exported: +* `id` - Specifies a data source ID in UUID format. + * `ids` - A list of all the subnet ids found. This data source will fail if none are found. diff --git a/docs/data-sources/vpc_subnet_v1.md b/docs/data-sources/vpc_subnet_v1.md index 4633e54dc..a2fb44731 100644 --- a/docs/data-sources/vpc_subnet_v1.md +++ b/docs/data-sources/vpc_subnet_v1.md @@ -28,23 +28,28 @@ The arguments of this data source act as filters for querying the available subnets in the current tenant. The given filters must match exactly one subnet whose data will be exported as attributes. -* `id` - (Optional) - Specifies the ID in UUID format. +* `region` - (Optional, String) 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. -* `name` (Optional) - The name of the specific subnet to retrieve. +* `id` - (Optional, String) - Specifies the ID in UUID format. -* `cidr` (Optional) - The network segment of specific subnet to retrieve. The value must be in CIDR format. +* `name` (Optional, String) - The name of the specific subnet to retrieve. -* `status` (Optional) - The value can be ACTIVE, DOWN, UNKNOWN, or ERROR. +* `cidr` (Optional, String) - The network segment of specific subnet to retrieve. The value must be in CIDR format. -* `vpc_id` (Optional) - The id of the VPC that the desired subnet belongs to. +* `status` (Optional, String) - The value can be ACTIVE, DOWN, UNKNOWN, or ERROR. -* `gateway_ip` (Optional) - The subnet gateway address of specific subnet. +* `vpc_id` (Optional, String) - The id of the VPC that the desired subnet belongs to. -* `primary_dns` (Optional) - The IP address of DNS server 1 on the specific subnet. +* `gateway_ip` (Optional, String) - The subnet gateway address of specific subnet. -* `secondary_dns` (Optional) - The IP address of DNS server 2 on the specific subnet. +* `primary_dns` (Optional, String) - The IP address of DNS server 1 on the specific subnet. -* `availability_zone` (Optional) - The availability zone (AZ) to which the subnet should belong. +* `secondary_dns` (Optional, String) - The IP address of DNS server 2 on the specific subnet. + +* `availability_zone` (Optional, String) - The availability zone (AZ) to which the subnet should belong. + +* `description` - The description of the subnet. ## **Attributes Reference** diff --git a/docs/data-sources/vpc_v1.md b/docs/data-sources/vpc_v1.md index 640210fa0..ccc82bc06 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` - The destination network segment of a route. + +* `routes.nexthop` - The next hop of a route. diff --git a/docs/data-sources/vpcep_endpoints.md b/docs/data-sources/vpcep_endpoints.md index 21c6bb5cc..813d4f0b1 100644 --- a/docs/data-sources/vpcep_endpoints.md +++ b/docs/data-sources/vpcep_endpoints.md @@ -50,6 +50,9 @@ The `endpoints` block contains: * `whitelist` - List of IP or CIDR block which can access the VPC endpoint. * `private_domain_name` - DNS name pointing to the VPC endpoint ip. * `tags` - The key/value pairs to associate with the VPC endpoint. + + `key` - The tag key. Each tag key contains a maximum of 127 unicode characters but cannot be left blank. + + `value` - The tag value list. Each value contains a maximum of 255 Unicode characters. + Before using values, delete SBC spaces before and after the value. * `project_id` - The ID of the project holding the VPC endpoint. * `created_at` - Creation date of the VPC endpoint. * `updated_at` - Last update date of the VPC endpoint. diff --git a/docs/data-sources/vpcep_public_services.md b/docs/data-sources/vpcep_public_services.md index 456dd61b9..5b0870541 100644 --- a/docs/data-sources/vpcep_public_services.md +++ b/docs/data-sources/vpcep_public_services.md @@ -19,6 +19,9 @@ data "flexibleengine_vpcep_public_services" "dns_service" { ## Argument Reference +* `region` - (Optional, String) The region in which to obtain the public VPC endpoint services. + If omitted, the provider-level region will be used. + * `service_name` - (Optional, String) Specifies the name of the public VPC endpoint service. The value is not case-sensitive and supports fuzzy match. @@ -30,8 +33,6 @@ In addition to all arguments above, the following attributes are exported: * `id` - Specifies a data source ID in UUID format. -* `region` - The region in which to obtain the public VPC endpoint services. - * `services` - Indicates the public VPC endpoint services information. Structure is documented below. The `services` block contains: diff --git a/docs/resources/networking_secgroup_rule_v2.md b/docs/resources/networking_secgroup_rule_v2.md index cb1d36d77..7149d760e 100644 --- a/docs/resources/networking_secgroup_rule_v2.md +++ b/docs/resources/networking_secgroup_rule_v2.md @@ -31,21 +31,21 @@ resource "flexibleengine_networking_secgroup_rule_v2" "secgroup_rule_1" { The following arguments are supported: -* `region` - (Optional) The region in which to obtain the V2 networking client. +* `region` - (Optional, String, ForceNew) The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the `region` argument of the provider is used. Changing this creates a new security group rule. -* `security_group_id` - (Required) The security group ID the rule should belong +* `security_group_id` - (Required, String, ForceNew) The security group ID the rule should belong to. Changing this creates a new security group rule. -* `direction` - (Required) The direction of the rule, valid values are **ingress** +* `direction` - (Required, String, ForceNew) The direction of the rule, valid values are **ingress** or **egress**. Changing this creates a new security group rule. -* `ethertype` - (Required) The layer 3 protocol type, valid values are **IPv4** +* `ethertype` - (Required, String, ForceNew) The layer 3 protocol type, valid values are **IPv4** or **IPv6**. Changing this creates a new security group rule. -* `protocol` - (Optional) The layer 4 protocol type, valid values are following. +* `protocol` - (Optional, String, ForceNew) The layer 4 protocol type, valid values are following. Changing this creates a new security group rule. This is required if you want to specify a port range. + **tcp** + **udp** @@ -69,22 +69,24 @@ The following arguments are supported: + **udplite** + **vrrp** -* `port_range_min` - (Optional) The lower part of the allowed port range, valid +* `port_range_min` - (Optional, Int, ForceNew) The lower part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule. -* `port_range_max` - (Optional) The higher part of the allowed port range, valid +* `port_range_max` - (Optional, Int, ForceNew) The higher part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule. -* `remote_ip_prefix` - (Optional) The remote CIDR, the value needs to be a valid +* `remote_ip_prefix` - (Optional, String, ForceNew) The remote CIDR, the value needs to be a valid CIDR (i.e. 192.168.0.0/16). Changing this creates a new security group rule. -* `remote_group_id` - (Optional) The remote group id, the value needs to be an +* `remote_group_id` - (Optional, String, ForceNew) The remote group id, the value needs to be an FlexibleEngine ID of a security group in the same tenant. Changing this creates a new security group rule. -* `description` - (Optional) Specifies the supplementary information about the security group rule. +* `tenant_id` - (Optional, String, ForceNew) The owner of the security group. + +* `description` - (Optional, String, ForceNew) Specifies the supplementary information about the security group rule. This parameter can contain a maximum of 255 characters and cannot contain angle brackets (< or >). Changing this creates a new security group rule. @@ -94,6 +96,12 @@ In addition to all arguments above, the following attributes are exported: * `id` - The resource ID in UUID format. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `delete` - Default is 10 minute. + ## Import Security Group Rules can be imported using the `id`, e.g. diff --git a/docs/resources/networking_secgroup_v2.md b/docs/resources/networking_secgroup_v2.md index ea5c81ad3..08e9ed3d9 100644 --- a/docs/resources/networking_secgroup_v2.md +++ b/docs/resources/networking_secgroup_v2.md @@ -21,19 +21,21 @@ resource "flexibleengine_networking_secgroup_v2" "example_secgroup" { The following arguments are supported: -* `region` - (Optional) The region in which to obtain the V2 networking client. +* `region` - (Optional, String) The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the `region` argument of the provider is used. Changing this creates a new security group. -* `name` - (Required) A unique name for the security group. +* `name` - (Required, String) A unique name for the security group. -* `description` - (Optional) A unique name for the security group. +* `description` - (Optional, String) A unique name for the security group. -* `delete_default_rules` - (Optional) Whether or not to delete the default +* `delete_default_rules` - (Optional, String) Whether or not to delete the default egress security rules. This is `false` by default. See the below note for more information. +* `tenant_id` - (Optional, String, ForceNew) The owner of the security group. + ## Attributes Reference In addition to all arguments above, the following attributes are exported: @@ -68,6 +70,12 @@ behavior. Some FlexibleEngine clouds might provide additional rules and some mig not provide any rules at all (in which case the `delete_default_rules` setting is moot). +## Timeouts + +This resource provides the following timeouts configuration options: + +* `delete` - Default is 10 minute. + ## Import Security Groups can be imported using the `id`, e.g. diff --git a/docs/resources/vpc_flow_log_v1.md b/docs/resources/vpc_flow_log_v1.md index e795a68e7..377309665 100644 --- a/docs/resources/vpc_flow_log_v1.md +++ b/docs/resources/vpc_flow_log_v1.md @@ -69,10 +69,17 @@ In addition to all arguments above, the following attributes are exported: * `status` - The status of the flow log. The value can be `ACTIVE`, `DOWN` or `ERROR`. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. + ## Import VPC flow logs can be imported using the `id`, e.g. -```sh +```shell terraform import flexibleengine_vpc_flow_log_v1.flowlog1 41b9d73f-eb1c-4795-a100-59a99b062513 ``` diff --git a/docs/resources/vpc_peering_connection_accepter_v2.md b/docs/resources/vpc_peering_connection_accepter_v2.md index 19aa01723..dd13b4370 100644 --- a/docs/resources/vpc_peering_connection_accepter_v2.md +++ b/docs/resources/vpc_peering_connection_accepter_v2.md @@ -72,10 +72,13 @@ resource "flexibleengine_vpc_peering_connection_accepter_v2" "peer" { The following arguments are supported: -* `vpc_peering_connection_id` (Required) - The VPC Peering Connection ID to manage. +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the VPC peering connection accepter. + If omitted, the provider-level region will be used. Changing this creates a new VPC peering connection accepter. + +* `vpc_peering_connection_id` (Required, String, ForceNew) - The VPC Peering Connection ID to manage. Changing this creates a new VPC peering connection accepter. -* `accept` (Optional)- Whether or not to accept the peering request. Defaults to `false`. +* `accept` (Optional, Bool)- Whether or not to accept the peering request. Defaults to `false`. ## Removing flexibleengine_vpc_peering_connection_accepter_v2 from your configuration @@ -90,10 +93,10 @@ from your state file and management, but will not destroy the VPC Peering Connec All of the argument attributes except accept are also exported as result attributes. -* `name` - The VPC peering connection name. - * `id` - The VPC peering connection ID. +* `name` - The VPC peering connection name. + * `status` - The VPC peering connection status. * `vpc_id` - The ID of requester VPC involved in a VPC peering connection. @@ -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..696b302ee 100644 --- a/docs/resources/vpc_peering_connection_v2.md +++ b/docs/resources/vpc_peering_connection_v2.md @@ -35,15 +35,20 @@ resource "flexibleengine_vpc_peering_connection_v2" "peering" { The following arguments are supported: -* `name` (Required) - Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the VPC peering connection. + If omitted, the provider-level region will be used. Changing this creates a new VPC peering connection. -* `vpc_id` (Required) - Specifies the ID of a VPC involved in a VPC peering connection. +* `name` (Required, String) - Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. + +* `vpc_id` (Required, String, ForceNew) - Specifies the ID of a VPC involved in a VPC peering connection. + Changing this creates a new VPC peering connection. + +* `peer_vpc_id` (Required, String, ForceNew) - Specifies the VPC ID of the accepter tenant. Changing this creates a new VPC peering connection. -* `peer_vpc_id` (Required) - Specifies the VPC ID of the accepter tenant. Changing this creates a new VPC peering connection. +* `peer_tenant_id` (Optional, String, ForceNew) - Specified the Tenant 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. - ## Attributes Reference All of the argument attributes are also exported as @@ -53,6 +58,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..1219590f8 100644 --- a/docs/resources/vpc_route_v2.md +++ b/docs/resources/vpc_route_v2.md @@ -25,22 +25,35 @@ resource "flexibleengine_vpc_route_v2" "vpc_route" { The following arguments are supported: -* `destination` (Required) - Specifies the destination IP address or CIDR block. Changing this creates a new Route. +* `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. -* `nexthop` (Required) - Specifies the next hop. If the route type is peering, enter the VPC peering connection ID. +* `vpc_id` (Required, String, ForceNew) - Specifies the VPC for which a route is to be added. Changing this creates a new Route. -* `type` (Required) - Specifies the route type. Currently, the value can only be **peering**. +* `destination` (Required, String, ForceNew) - Specifies the destination IP address or CIDR block. Changing this creates a new Route. -* `vpc_id` (Required) - Specifies the VPC for which a route is to be added. Changing this creates a new Route. +* `nexthop` (Required, String, ForceNew) - Specifies the next hop. + If the route type is peering, enter the VPC peering connection ID. + Changing this creates a new Route. -* `tenant_id` (Optional) - Specifies the tenant ID. Only the administrator can specify the tenant ID of other tenant. +* `type` (Required, String, ForceNew) - Specifies the route type. Currently, the value can only be **peering**. Changing this creates a new Route. +* `tenant_id` (Optional, String, ForceNew) - Specifies the tenant ID. + Only the administrator can specify the tenant ID of other tenant. Changing this creates a new Route. + ## Attributes Reference 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. diff --git a/docs/resources/vpcep_approval.md b/docs/resources/vpcep_approval.md index 47695071e..707498ea0 100644 --- a/docs/resources/vpcep_approval.md +++ b/docs/resources/vpcep_approval.md @@ -61,9 +61,12 @@ resource "flexibleengine_vpcep_approval" "approval" { The following arguments are supported: -* `service_id` (Required) - Specifies the ID of the VPC endpoint service. Changing this creates a new resource. +* `region` - (Optional, String, ForceNew) The region in which to create the resource. + If omitted, the provider-level region will be used. Changing this creates a new resource. -* `endpoints` (Required) - Specifies the list of VPC endpoint IDs which accepted to connect to VPC endpoint service. +* `service_id` - (Required, String, ForceNew) Specifies the ID of the VPC endpoint service. Changing this creates a new resource. + +* `endpoints` - (Required, List) Specifies the list of VPC endpoint IDs which accepted to connect to VPC endpoint service. The VPC endpoints will be rejected when the resource was destroyed. ## Attributes Reference @@ -72,8 +75,6 @@ In addition to all arguments above, the following attributes are exported: * `id` - The unique ID in UUID format which equals to the ID of the VPC endpoint service. -* `region` - The region in which to obtain the VPC endpoint service. - * `connections` - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below. - `endpoint_id` - The unique ID of the VPC endpoint. - `packet_id` - The packet ID of the VPC endpoint. @@ -85,4 +86,4 @@ In addition to all arguments above, the following attributes are exported: This resource provides the following timeouts configuration options: * `create` - Default is 10 minute. -* `delete` - Default is 3 minute. +* `delete` - Default is 10 minute. diff --git a/docs/resources/vpcep_endpoint.md b/docs/resources/vpcep_endpoint.md index 242013cba..dab07707b 100644 --- a/docs/resources/vpcep_endpoint.md +++ b/docs/resources/vpcep_endpoint.md @@ -81,28 +81,31 @@ resource "flexibleengine_vpcep_endpoint" "demo" { The following arguments are supported: -* `service_id` (Required) - Specifies the ID of the VPC endpoint service. +* `region` - (Optional, String, ForceNew) The region in which to create the VPC endpoint. + If omitted, the provider-level region will be used. Changing this creates a new VPC endpoint. + +* `service_id` - (Required, String, ForceNew) Specifies the ID of the VPC endpoint service. Changing this creates a new VPC endpoint. -* `vpc_id` (Required) - Specifies the ID of the VPC where the VPC endpoint is to be created. +* `vpc_id` - (Required, String, ForceNew) Specifies the ID of the VPC where the VPC endpoint is to be created. Changing this creates a new VPC endpoint. -* `network_id` (Required) - Specifies the network ID of the subnet in the VPC specified by `vpc_id`. +* `network_id` - (Required, String, ForceNew) Specifies the network ID of the subnet in the VPC specified by `vpc_id`. Changing this creates a new VPC endpoint. -* `ip_address` (Optional) - Specifies the IP address for accessing the associated VPC endpoint service. +* `ip_address` - (Optional, String, ForceNew) Specifies the IP address for accessing the associated VPC endpoint service. Only IPv4 addresses are supported. Changing this creates a new VPC endpoint. -* `enable_dns` (Optional) - Specifies whether to create a private domain name. The default value is true. +* `enable_dns` - (Optional, Bool, ForceNew) Specifies whether to create a private domain name. The default value is true. Changing this creates a new VPC endpoint. -* `enable_whitelist` (Optional) - Specifies whether to enable access control. The default value is false. +* `enable_whitelist` (Optional, Bool, ForceNew) - Specifies whether to enable access control. The default value is false. Changing this creates a new VPC endpoint. -* `whitelist` (Optional) - Specifies the list of IP address or CIDR block which can be accessed to the VPC endpoint. - Changing this creates a new VPC endpoint. +* `whitelist` (Optional, List, ForceNew) - Specifies the list of IP address or CIDR block, + which can be accessed to the VPC endpoint. Changing this creates a new VPC endpoint. -* `tags` - (Optional) The key/value pairs to associate with the VPC endpoint. +* `tags` - (Optional, Map) The key/value pairs to associate with the VPC endpoint. ## Attributes Reference @@ -110,8 +113,6 @@ In addition to all arguments above, the following attributes are exported: * `id` - The unique ID of the VPC endpoint. -* `region` - The region in which to create the VPC endpoint. - * `status` - The status of the VPC endpoint. The value can be **accepted**, **pendingAcceptance** or **rejected**. * `service_name` - The name of the VPC endpoint service. @@ -123,6 +124,13 @@ In addition to all arguments above, the following attributes are exported: * `private_domain_name` - The domain name for accessing the associated VPC endpoint service. This parameter is only available when enable_dns is set to true. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. + ## Import VPC endpoint can be imported using the `id`, e.g. diff --git a/docs/resources/vpcep_service.md b/docs/resources/vpcep_service.md index ca7e19338..a8cd50e09 100644 --- a/docs/resources/vpcep_service.md +++ b/docs/resources/vpcep_service.md @@ -35,62 +35,70 @@ resource "flexibleengine_vpcep_service" "demo" { The following arguments are supported: -* `name` (Optional) - Specifies the name of the VPC endpoint service. The value contains a maximum of +* `region` - (Optional, String, ForceNew) The region in which to create the VPC endpoint service. + If omitted, the provider-level region will be used. Changing this creates a new VPC endpoint service resource. + +* `name` - (Optional, String) Specifies the name of the VPC endpoint service. The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-). -* `vpc_id` (Required) - Specifies the ID of the VPC to which the backend resource of +* `vpc_id` - (Required, String, ForceNew) Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs. Changing this creates a new VPC endpoint service. -* `server_type` (Required) - Specifies the backend resource type. The value can be **VM**, **VIP** or **LB**. +* `server_type` - (Required, String, ForceNew) Specifies the backend resource type. The value can be **VM**, **VIP** or **LB**. Changing this creates a new VPC endpoint service. -* `port_id` (Required) - Specifies the ID for identifying the backend resource of the VPC endpoint service. +* `port_id` (Required, String) - Specifies the ID for identifying the backend resource of the VPC endpoint service. - If the `server_type` is **VM**, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. - If the `server_type` is **VIP**, the value is the NIC ID of the physical server where virtual resources are created. - If the `server_type` is **LB**, the value is the ID of the port bound to the private IP address of the load balancer. -* `port_mapping` (Required) - Specified the port mappings opened to the VPC endpoint service. +* `port_mapping` (Required, List) - Specified the port mappings opened to the VPC endpoint service. Structure is documented below. -* `approval` (Optional) - Specifies whether connection approval is required. The default value is false. +* `approval` (Optional, Bool) - Specifies whether connection approval is required. The default value is false. -* `permissions` (Optional) - Specifies the list of accounts to access the VPC endpoint service. +* `permissions` (Optional, Set) - Specifies the list of accounts to access the VPC endpoint service. The record is in the `iam:domain::domain_id` format, while `*` allows all users to access the VPC endpoint service. -* `tags` - (Optional) The key/value pairs to associate with the VPC endpoint service. +* `tags` - (Optional, Map) The key/value pairs to associate with the VPC endpoint service. The `port_mapping` block supports: -* `protocol` - (Optional) Specifies the protocol used in port mappings. +* `protocol` - (Optional, String) Specifies the protocol used in port mappings. The value can be *TCP* or *UDP*. The default value is *TCP*. -* `service_port` - (Optional) Specifies the port for accessing the VPC endpoint service. +* `service_port` - (Optional, Int) Specifies the port for accessing the VPC endpoint service. This port is provided by the backend service to provide services. The value ranges from 1 to 65535. -* `terminal_port` - (Optional) Specifies the port for accessing the VPC endpoint. +* `terminal_port` - (Optional, Int) Specifies the port for accessing the VPC endpoint. This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. The value ranges from 1 to 65535. +* `service_type` - (Optional, String)The type of the VPC endpoint service. Only **interface** can be configured. + ## Attributes Reference In addition to all arguments above, the following attributes are exported: * `id` - The unique ID of the VPC endpoint service. -* `region` - The region in which to create the VPC endpoint service. - * `status` - The status of the VPC endpoint service. The value can be **available** or **failed**. * `service_name` - The full name of the VPC endpoint service in the format: *region.name.id*. -* `service_type` - The type of the VPC endpoint service. Only **interface** can be configured. - * `connections` - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below. - `endpoint_id` - The unique ID of the VPC endpoint. - `packet_id` - The packet ID of the VPC endpoint. - `domain_id` - The user's domain ID. - `status` - The connection status of the VPC endpoint. +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minute. +* `delete` - Default is 10 minute. + ## Import VPC endpoint services can be imported using the `id`, e.g.