doc(rdb): one of enable_ipam or static ip must be defined (#2487)

scaleway · Apr 3, 2024 · 57a06da · 57a06da
1 parent b684555
commit 57a06da
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/resources/rdb_instance.md b/docs/resources/rdb_instance.md
@@ -180,12 +180,14 @@ Please consult the [GoDoc](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-g
     - `pn_id` - (Required) The ID of the private network.
     - `ip_net` - (Optional) The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
     - `enable_ipam` - (Optional) If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
+
+~> **Important:** One of `ip_net` or `enable_ipam=true` must be set.
+
+~> **Important:** Updates to `private_network` will recreate the Instance's endpoint
 
 ~> **NOTE:** Please calculate your host IP using [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost). Otherwise, let IPAM service
 handle the host IP on the network.
 
-~> **Important:** Updates to `private_network` will recreate the Instance's endpoint
-
 - `load_balancer` - (Optional) List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is.
 This block must be defined if you want a public endpoint in addition to your private endpoint.
 

diff --git a/docs/resources/rdb_read_replica.md b/docs/resources/rdb_read_replica.md
@@ -94,6 +94,8 @@ The following arguments are supported:
     - `service_ip` - (Optional) The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
     - `enable_ipam` - (Optional) If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
 
+~> **Important:** One of `service_ip` or `enable_ipam=true` must be set.
+
 - `same_zone` - (Defaults to `true`) Defines whether to create the replica in the same availability zone as the main instance nodes or not.
 
 - `region` - (Defaults to [provider](../index.md#arguments-reference) `region`) The [region](../guides/regions_and_zones.md#regions)