Updated documents for vpn gateway connection

Ramya-c4 · Sep 10, 2024 · 60c622f · 60c622f
1 parent a9b135f
commit 60c622f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 15 deletions.
diff --git a/website/docs/d/is_vpn_gateway_connection.html.markdown b/website/docs/d/is_vpn_gateway_connection.html.markdown
@@ -89,7 +89,7 @@ In addition to all argument references listed, you can access the following attr
 	Nested schema for **local**:
 	- `ike_identities` - (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member.
 		Nested schema for **ike_identities**:
-		- `type` - (String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (String) The IKE identity FQDN value.
 
 - `mode` - (String) The mode of the VPN gateway.
@@ -102,7 +102,7 @@ In addition to all argument references listed, you can access the following attr
 	- `fqdn` - (String) The FQDN of the peer VPN gateway for this connection.
 	- `ike_identity` - (List) The peer IKE identity.
 		Nested schema for **ike_identity**:
-		- `type` - (String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (String) The IKE identity FQDN value.
 	- `type` - (String) Indicates whether `peer.address` or `peer.fqdn` is used.
 

diff --git a/website/docs/d/is_vpn_gateway_connections.html.markdown b/website/docs/d/is_vpn_gateway_connections.html.markdown
@@ -52,7 +52,7 @@ In addition to all argument reference list, you can access the following attribu
 	Nested schema for **local**:
 	- `ike_identities` - (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member.
 		Nested schema for **ike_identities**:
-		- `type` - (String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (String) The IKE identity FQDN value.
 - `local_cidrs` - (String) The VPN gateway connection local CIDRs.
 - `mode` - (String) The mode of the VPN gateway.
@@ -63,7 +63,7 @@ In addition to all argument reference list, you can access the following attribu
 	- `fqdn` - (String) The FQDN of the peer VPN gateway for this connection.
 	- `ike_identity` - (List) The peer IKE identity.
 		Nested schema for **ike_identity**:
-		- `type` - (String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (String) The IKE identity FQDN value.
 	- `type` - (String) Indicates whether `peer.address` or `peer.fqdn` is used.
 

diff --git a/website/docs/r/is_vpn_gateway_connection.html.markdown b/website/docs/r/is_vpn_gateway_connection.html.markdown
@@ -53,10 +53,17 @@ resource "ibm_is_vpn_gateway" "example" {
 resource "ibm_is_vpn_gateway_connection" "example" {
   name          = "example-vpn-gateway-connection"
   vpn_gateway   = ibm_is_vpn_gateway.example.id
-  peer_address  = ibm_is_vpn_gateway.example.public_ip_address
   preshared_key = "VPNDemoPassword"
-  local_cidrs   = [ibm_is_subnet.example.ipv4_cidr_block]
-  peer_cidrs    = [ibm_is_subnet.example2.ipv4_cidr_block]
+  # peer_address  = ibm_is_vpn_gateway.example.public_ip_address # deprecated, replaced with peer block
+  # peer_cidrs    = [ibm_is_subnet.example2.ipv4_cidr_block] # deprecated, replaced with peer block
+  peer {
+      address  = ibm_is_vpn_gateway.example.public_ip_address
+      cidrs    = [ibm_is_subnet.example2.ipv4_cidr_block]   
+  }
+  # local_cidrs   = [ibm_is_subnet.example.ipv4_cidr_block] # deprecated, replaced with local block
+  local {
+      cidrs   = [ibm_is_subnet.example.ipv4_cidr_block]
+  }
 }
 
 ```
@@ -73,10 +80,18 @@ resource "ibm_is_vpn_gateway" "example" {
 resource "ibm_is_vpn_gateway_connection" "example" {
   name          = "example-vpn-gateway-connection"
   vpn_gateway   = ibm_is_vpn_gateway.example.id
-  peer_address  = ibm_is_vpn_gateway.example.public_ip_address != "0.0.0.0" ? ibm_is_vpn_gateway.example.public_ip_address : ibm_is_vpn_gateway.example.public_ip_address2
   preshared_key = "VPNDemoPassword"
-  local_cidrs   = [ibm_is_subnet.example.ipv4_cidr_block]
-  peer_cidrs    = [ibm_is_subnet.example2.ipv4_cidr_block]
+
+  # local_cidrs   = [ibm_is_subnet.example.ipv4_cidr_block] # depcreated
+  local {
+    cidrs = [ibm_is_subnet.example.ipv4_cidr_block]
+  }
+  # peer_cidrs    = [ibm_is_subnet.example2.ipv4_cidr_block] # depcreated
+  # peer_address  = ibm_is_vpn_gateway.example.public_ip_address != "0.0.0.0" ? ibm_is_vpn_gateway.example.public_ip_address : ibm_is_vpn_gateway.example.public_ip_address2 # depcreated
+  peer {
+    address   = ibm_is_vpn_gateway.example.public_ip_address != "0.0.0.0" ? ibm_is_vpn_gateway.example.public_ip_address : ibm_is_vpn_gateway.example.public_ip_address2
+    cidrs     = [ibm_is_subnet.example2.ipv4_cidr_block]
+  }
 }
 
 ```
@@ -100,22 +115,22 @@ Review the argument references that you can specify for your resource.
   Nested schema for **local**:
 	- `ike_identities` - (Required, List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member.
 	  Nested schema for **ike_identities**:
-		- `type` - (Required, String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (Required, String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (Optional, String) The IKE identity FQDN value.
-- `local_cidrs` - (Optional, DEPRECATED, Forces new resource, List) List of local CIDRs for this resource.
+- `local_cidrs` - (Optional, DEPRECATED, Forces new resource, List) List of local CIDRs for this resource. `local_cidrs` is deprecated and use `local` block instead. 
 - `name` - (Required, String) The name of the VPN gateway connection.
 - `peer` - (Optional, List) 
   Nested schema for **peer**:
 	- `address` - (Optional, String) The IP address of the peer VPN gateway for this connection.
 	- `fqdn` - (Optional, String) The FQDN of the peer VPN gateway for this connection.
 	- `ike_identity` - (Required, List) The peer IKE identity.
 	  Nested schema for **ike_identity**:
-		- `type` - (Required, String) The IKE identity type.The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
+		- `type` - (Required, String) The IKE identity type. [ **fqdn**, **hostname**, **ipv4_address**, **key_id** ] The enumerated values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.
 		- `value` - (Optional, String) The IKE identity FQDN value.
 	- `type` - (Computed, String) Indicates whether `peer.address` or `peer.fqdn` is used.
 
-- `peer_cidrs` - (Optional, DEPRECATED, Forces new resource, List) List of peer CIDRs for this resource.
-- `peer_address` - (Optional, DEPRECATED, String) The IP address of the peer VPN gateway.
+- `peer_cidrs` - (Optional, DEPRECATED, Forces new resource, List) List of peer CIDRs for this resource. `peer_cidrs` is deprecated and use `peer` block instead.
+- `peer_address` - (Optional, DEPRECATED, String) The IP address of the peer VPN gateway. `peer_address` is deprecated and use `peer` block instead.
 - `preshared_key` - (Required, Forces new resource, String) The preshared key.
 - `timeout` - (Optional, Integer) Dead peer detection timeout in seconds. Default value is 10.
 - `vpn_gateway` - (Required, Forces new resource, String) The unique identifier of the VPN gateway.