feat(lb): display ipam_id for pn attachment in doc (#579)

Author: scaleway-bot

scaleway-async/scaleway_async/lb/v1/api.py

@@ -3128,6 +3128,7 @@ async def attach_private_network(
         static_config: Optional[PrivateNetworkStaticConfig] = None,
         dhcp_config: Optional[PrivateNetworkDHCPConfig] = None,
         ipam_config: Optional[PrivateNetworkIpamConfig] = None,
+        ipam_ids: Optional[List[str]] = None,
     ) -> PrivateNetwork:
         """
         Attach a Load Balancer to a Private Network.
@@ -3141,6 +3142,7 @@ async def attach_private_network(
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
         :param ipam_config: For internal use only.
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
+        :param ipam_ids: IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -3166,6 +3168,7 @@ async def attach_private_network(
                     lb_id=lb_id,
                     private_network_id=private_network_id,
                     zone=zone,
+                    ipam_ids=ipam_ids,
                     static_config=static_config,
                     dhcp_config=dhcp_config,
                     ipam_config=ipam_config,
@@ -6140,6 +6143,7 @@ async def attach_private_network(
         static_config: Optional[PrivateNetworkStaticConfig] = None,
         dhcp_config: Optional[PrivateNetworkDHCPConfig] = None,
         ipam_config: Optional[PrivateNetworkIpamConfig] = None,
+        ipam_ids: Optional[List[str]] = None,
     ) -> PrivateNetwork:
         """
         Add load balancer on instance private network.
@@ -6152,6 +6156,7 @@ async def attach_private_network(
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
         :param ipam_config: For internal use only.
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
+        :param ipam_ids: IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -6179,6 +6184,7 @@ async def attach_private_network(
                     lb_id=lb_id,
                     private_network_id=private_network_id,
                     region=region,
+                    ipam_ids=ipam_ids,
                     static_config=static_config,
                     dhcp_config=dhcp_config,
                     ipam_config=ipam_config,

scaleway-async/scaleway_async/lb/v1/marshalling.py

@@ -1559,6 +1559,9 @@ def marshal_AttachPrivateNetworkRequest(
         ),
     )
 
+    if request.ipam_ids is not None:
+        output["ipam_ids"] = request.ipam_ids
+
     return output
 
 
@@ -2424,6 +2427,9 @@ def marshal_ZonedApiAttachPrivateNetworkRequest(
         ),
     )
 
+    if request.ipam_ids is not None:
+        output["ipam_ids"] = request.ipam_ids
+
     return output
 
 

scaleway-async/scaleway_async/lb/v1/types.py

@@ -1235,6 +1235,11 @@ class AttachPrivateNetworkRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
+    ipam_ids: Optional[List[str]]
+    """
+    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
+    """
+
     static_config: Optional[PrivateNetworkStaticConfig]
 
     dhcp_config: Optional[PrivateNetworkDHCPConfig]
@@ -2874,6 +2879,11 @@ class ZonedApiAttachPrivateNetworkRequest:
     Zone to target. If none is passed will use default zone from the config.
     """
 
+    ipam_ids: Optional[List[str]]
+    """
+    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
+    """
+
     static_config: Optional[PrivateNetworkStaticConfig]
 
     dhcp_config: Optional[PrivateNetworkDHCPConfig]

scaleway/scaleway/lb/v1/api.py

@@ -3126,6 +3126,7 @@ def attach_private_network(
         static_config: Optional[PrivateNetworkStaticConfig] = None,
         dhcp_config: Optional[PrivateNetworkDHCPConfig] = None,
         ipam_config: Optional[PrivateNetworkIpamConfig] = None,
+        ipam_ids: Optional[List[str]] = None,
     ) -> PrivateNetwork:
         """
         Attach a Load Balancer to a Private Network.
@@ -3139,6 +3140,7 @@ def attach_private_network(
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
         :param ipam_config: For internal use only.
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
+        :param ipam_ids: IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -3164,6 +3166,7 @@ def attach_private_network(
                     lb_id=lb_id,
                     private_network_id=private_network_id,
                     zone=zone,
+                    ipam_ids=ipam_ids,
                     static_config=static_config,
                     dhcp_config=dhcp_config,
                     ipam_config=ipam_config,
@@ -6136,6 +6139,7 @@ def attach_private_network(
         static_config: Optional[PrivateNetworkStaticConfig] = None,
         dhcp_config: Optional[PrivateNetworkDHCPConfig] = None,
         ipam_config: Optional[PrivateNetworkIpamConfig] = None,
+        ipam_ids: Optional[List[str]] = None,
     ) -> PrivateNetwork:
         """
         Add load balancer on instance private network.
@@ -6148,6 +6152,7 @@ def attach_private_network(
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
         :param ipam_config: For internal use only.
         One-Of ('config'): at most one of 'static_config', 'dhcp_config', 'ipam_config' could be set.
+        :param ipam_ids: IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
         :return: :class:`PrivateNetwork <PrivateNetwork>`
 
         Usage:
@@ -6175,6 +6180,7 @@ def attach_private_network(
                     lb_id=lb_id,
                     private_network_id=private_network_id,
                     region=region,
+                    ipam_ids=ipam_ids,
                     static_config=static_config,
                     dhcp_config=dhcp_config,
                     ipam_config=ipam_config,

scaleway/scaleway/lb/v1/marshalling.py

@@ -1559,6 +1559,9 @@ def marshal_AttachPrivateNetworkRequest(
         ),
     )
 
+    if request.ipam_ids is not None:
+        output["ipam_ids"] = request.ipam_ids
+
     return output
 
 
@@ -2424,6 +2427,9 @@ def marshal_ZonedApiAttachPrivateNetworkRequest(
         ),
     )
 
+    if request.ipam_ids is not None:
+        output["ipam_ids"] = request.ipam_ids
+
     return output
 
 

scaleway/scaleway/lb/v1/types.py

@@ -1235,6 +1235,11 @@ class AttachPrivateNetworkRequest:
     Region to target. If none is passed will use default region from the config.
     """
 
+    ipam_ids: Optional[List[str]]
+    """
+    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
+    """
+
     static_config: Optional[PrivateNetworkStaticConfig]
 
     dhcp_config: Optional[PrivateNetworkDHCPConfig]
@@ -2874,6 +2879,11 @@ class ZonedApiAttachPrivateNetworkRequest:
     Zone to target. If none is passed will use default zone from the config.
     """
 
+    ipam_ids: Optional[List[str]]
+    """
+    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network.
+    """
+
     static_config: Optional[PrivateNetworkStaticConfig]
 
     dhcp_config: Optional[PrivateNetworkDHCPConfig]