pulumiverse-scaleway 1.25.0a1742464679__py3-none-any.whl → 1.26.0__py3-none-any.whl

pulumiverse_scaleway/network/get_public_gateway_pat_rule.py

@@ -0,0 +1,313 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = [
+    'GetPublicGatewayPatRuleResult',
+    'AwaitableGetPublicGatewayPatRuleResult',
+    'get_public_gateway_pat_rule',
+    'get_public_gateway_pat_rule_output',
+]
+
+@pulumi.output_type
+class GetPublicGatewayPatRuleResult:
+    """
+    A collection of values returned by getPublicGatewayPatRule.
+    """
+    def __init__(__self__, created_at=None, gateway_id=None, id=None, organization_id=None, pat_rule_id=None, private_ip=None, private_port=None, protocol=None, public_port=None, updated_at=None, zone=None):
+        if created_at and not isinstance(created_at, str):
+            raise TypeError("Expected argument 'created_at' to be a str")
+        pulumi.set(__self__, "created_at", created_at)
+        if gateway_id and not isinstance(gateway_id, str):
+            raise TypeError("Expected argument 'gateway_id' to be a str")
+        pulumi.set(__self__, "gateway_id", gateway_id)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if organization_id and not isinstance(organization_id, str):
+            raise TypeError("Expected argument 'organization_id' to be a str")
+        pulumi.set(__self__, "organization_id", organization_id)
+        if pat_rule_id and not isinstance(pat_rule_id, str):
+            raise TypeError("Expected argument 'pat_rule_id' to be a str")
+        pulumi.set(__self__, "pat_rule_id", pat_rule_id)
+        if private_ip and not isinstance(private_ip, str):
+            raise TypeError("Expected argument 'private_ip' to be a str")
+        pulumi.set(__self__, "private_ip", private_ip)
+        if private_port and not isinstance(private_port, int):
+            raise TypeError("Expected argument 'private_port' to be a int")
+        pulumi.set(__self__, "private_port", private_port)
+        if protocol and not isinstance(protocol, str):
+            raise TypeError("Expected argument 'protocol' to be a str")
+        pulumi.set(__self__, "protocol", protocol)
+        if public_port and not isinstance(public_port, int):
+            raise TypeError("Expected argument 'public_port' to be a int")
+        pulumi.set(__self__, "public_port", public_port)
+        if updated_at and not isinstance(updated_at, str):
+            raise TypeError("Expected argument 'updated_at' to be a str")
+        pulumi.set(__self__, "updated_at", updated_at)
+        if zone and not isinstance(zone, str):
+            raise TypeError("Expected argument 'zone' to be a str")
+        pulumi.set(__self__, "zone", zone)
+
+    @property
+    @pulumi.getter(name="createdAt")
+    def created_at(self) -> str:
+        return pulumi.get(self, "created_at")
+
+    @property
+    @pulumi.getter(name="gatewayId")
+    def gateway_id(self) -> str:
+        """
+        The ID of the Public Gateway.
+        """
+        return pulumi.get(self, "gateway_id")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="organizationId")
+    def organization_id(self) -> str:
+        return pulumi.get(self, "organization_id")
+
+    @property
+    @pulumi.getter(name="patRuleId")
+    def pat_rule_id(self) -> str:
+        return pulumi.get(self, "pat_rule_id")
+
+    @property
+    @pulumi.getter(name="privateIp")
+    def private_ip(self) -> str:
+        """
+        The private IP address to forward data to.
+        """
+        return pulumi.get(self, "private_ip")
+
+    @property
+    @pulumi.getter(name="privatePort")
+    def private_port(self) -> int:
+        """
+        The private port to translate to.
+        """
+        return pulumi.get(self, "private_port")
+
+    @property
+    @pulumi.getter
+    def protocol(self) -> str:
+        """
+        The protocol the rule should apply to. Possible values are `both`, `tcp` and `udp`.
+        """
+        return pulumi.get(self, "protocol")
+
+    @property
+    @pulumi.getter(name="publicPort")
+    def public_port(self) -> int:
+        """
+        The public port to listen on.
+        """
+        return pulumi.get(self, "public_port")
+
+    @property
+    @pulumi.getter(name="updatedAt")
+    def updated_at(self) -> str:
+        return pulumi.get(self, "updated_at")
+
+    @property
+    @pulumi.getter
+    def zone(self) -> Optional[str]:
+        return pulumi.get(self, "zone")
+
+
+class AwaitableGetPublicGatewayPatRuleResult(GetPublicGatewayPatRuleResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetPublicGatewayPatRuleResult(
+            created_at=self.created_at,
+            gateway_id=self.gateway_id,
+            id=self.id,
+            organization_id=self.organization_id,
+            pat_rule_id=self.pat_rule_id,
+            private_ip=self.private_ip,
+            private_port=self.private_port,
+            protocol=self.protocol,
+            public_port=self.public_port,
+            updated_at=self.updated_at,
+            zone=self.zone)
+
+
+def get_public_gateway_pat_rule(pat_rule_id: Optional[str] = None,
+                                zone: Optional[str] = None,
+                                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPublicGatewayPatRuleResult:
+    """
+    Gets information about a Public Gateway PAT rule. For further information, please see the
+    [API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-pat-rules-list-pat-rules).
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    sg01 = scaleway.instance.SecurityGroup("sg01",
+        inbound_default_policy="drop",
+        outbound_default_policy="accept",
+        inbound_rules=[{
+            "action": "accept",
+            "port": 22,
+            "protocol": "TCP",
+        }])
+    srv01 = scaleway.instance.Server("srv01",
+        name="my-server",
+        type="PLAY2-NANO",
+        image="ubuntu_jammy",
+        security_group_id=sg01.id)
+    pn01 = scaleway.network.PrivateNetwork("pn01", name="my-pn")
+    pnic01 = scaleway.instance.PrivateNic("pnic01",
+        server_id=srv01.id,
+        private_network_id=pn01.id)
+    dhcp01 = scaleway.network.PublicGatewayDhcp("dhcp01", subnet="192.168.0.0/24")
+    ip01 = scaleway.network.PublicGatewayIp("ip01")
+    pg01 = scaleway.network.PublicGateway("pg01",
+        name="my-pg",
+        type="VPC-GW-S",
+        ip_id=ip01.id)
+    gn01 = scaleway.network.GatewayNetwork("gn01",
+        gateway_id=pg01.id,
+        private_network_id=pn01.id,
+        dhcp_id=dhcp01.id,
+        cleanup_dhcp=True,
+        enable_masquerade=True)
+    rsv01 = scaleway.network.PublicGatewayDhcpReservation("rsv01",
+        gateway_network_id=gn01.id,
+        mac_address=pnic01.mac_address,
+        ip_address="192.168.0.7")
+    pat01 = scaleway.network.PublicGatewayPatRule("pat01",
+        gateway_id=pg01.id,
+        private_ip=rsv01.ip_address,
+        private_port=22,
+        public_port=2202,
+        protocol="tcp")
+    main = scaleway.network.get_public_gateway_pat_rule_output(pat_rule_id=pat01.id)
+    ```
+
+
+    :param str pat_rule_id: The ID of the PAT rule to retrieve
+    :param str zone: `zone`) The zone in which
+           the rule exists.
+    """
+    __args__ = dict()
+    __args__['patRuleId'] = pat_rule_id
+    __args__['zone'] = zone
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:network/getPublicGatewayPatRule:getPublicGatewayPatRule', __args__, opts=opts, typ=GetPublicGatewayPatRuleResult).value
+
+    return AwaitableGetPublicGatewayPatRuleResult(
+        created_at=pulumi.get(__ret__, 'created_at'),
+        gateway_id=pulumi.get(__ret__, 'gateway_id'),
+        id=pulumi.get(__ret__, 'id'),
+        organization_id=pulumi.get(__ret__, 'organization_id'),
+        pat_rule_id=pulumi.get(__ret__, 'pat_rule_id'),
+        private_ip=pulumi.get(__ret__, 'private_ip'),
+        private_port=pulumi.get(__ret__, 'private_port'),
+        protocol=pulumi.get(__ret__, 'protocol'),
+        public_port=pulumi.get(__ret__, 'public_port'),
+        updated_at=pulumi.get(__ret__, 'updated_at'),
+        zone=pulumi.get(__ret__, 'zone'))
+def get_public_gateway_pat_rule_output(pat_rule_id: Optional[pulumi.Input[str]] = None,
+                                       zone: Optional[pulumi.Input[Optional[str]]] = None,
+                                       opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetPublicGatewayPatRuleResult]:
+    """
+    Gets information about a Public Gateway PAT rule. For further information, please see the
+    [API documentation](https://www.scaleway.com/en/developers/api/public-gateway/#path-pat-rules-list-pat-rules).
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    sg01 = scaleway.instance.SecurityGroup("sg01",
+        inbound_default_policy="drop",
+        outbound_default_policy="accept",
+        inbound_rules=[{
+            "action": "accept",
+            "port": 22,
+            "protocol": "TCP",
+        }])
+    srv01 = scaleway.instance.Server("srv01",
+        name="my-server",
+        type="PLAY2-NANO",
+        image="ubuntu_jammy",
+        security_group_id=sg01.id)
+    pn01 = scaleway.network.PrivateNetwork("pn01", name="my-pn")
+    pnic01 = scaleway.instance.PrivateNic("pnic01",
+        server_id=srv01.id,
+        private_network_id=pn01.id)
+    dhcp01 = scaleway.network.PublicGatewayDhcp("dhcp01", subnet="192.168.0.0/24")
+    ip01 = scaleway.network.PublicGatewayIp("ip01")
+    pg01 = scaleway.network.PublicGateway("pg01",
+        name="my-pg",
+        type="VPC-GW-S",
+        ip_id=ip01.id)
+    gn01 = scaleway.network.GatewayNetwork("gn01",
+        gateway_id=pg01.id,
+        private_network_id=pn01.id,
+        dhcp_id=dhcp01.id,
+        cleanup_dhcp=True,
+        enable_masquerade=True)
+    rsv01 = scaleway.network.PublicGatewayDhcpReservation("rsv01",
+        gateway_network_id=gn01.id,
+        mac_address=pnic01.mac_address,
+        ip_address="192.168.0.7")
+    pat01 = scaleway.network.PublicGatewayPatRule("pat01",
+        gateway_id=pg01.id,
+        private_ip=rsv01.ip_address,
+        private_port=22,
+        public_port=2202,
+        protocol="tcp")
+    main = scaleway.network.get_public_gateway_pat_rule_output(pat_rule_id=pat01.id)
+    ```
+
+
+    :param str pat_rule_id: The ID of the PAT rule to retrieve
+    :param str zone: `zone`) The zone in which
+           the rule exists.
+    """
+    __args__ = dict()
+    __args__['patRuleId'] = pat_rule_id
+    __args__['zone'] = zone
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:network/getPublicGatewayPatRule:getPublicGatewayPatRule', __args__, opts=opts, typ=GetPublicGatewayPatRuleResult)
+    return __ret__.apply(lambda __response__: GetPublicGatewayPatRuleResult(
+        created_at=pulumi.get(__response__, 'created_at'),
+        gateway_id=pulumi.get(__response__, 'gateway_id'),
+        id=pulumi.get(__response__, 'id'),
+        organization_id=pulumi.get(__response__, 'organization_id'),
+        pat_rule_id=pulumi.get(__response__, 'pat_rule_id'),
+        private_ip=pulumi.get(__response__, 'private_ip'),
+        private_port=pulumi.get(__response__, 'private_port'),
+        protocol=pulumi.get(__response__, 'protocol'),
+        public_port=pulumi.get(__response__, 'public_port'),
+        updated_at=pulumi.get(__response__, 'updated_at'),
+        zone=pulumi.get(__response__, 'zone')))

pulumiverse_scaleway/network/get_routes.py

@@ -0,0 +1,208 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+
+__all__ = [
+    'GetRoutesResult',
+    'AwaitableGetRoutesResult',
+    'get_routes',
+    'get_routes_output',
+]
+
+@pulumi.output_type
+class GetRoutesResult:
+    """
+    A collection of values returned by getRoutes.
+    """
+    def __init__(__self__, id=None, is_ipv6=None, nexthop_private_network_id=None, nexthop_resource_id=None, nexthop_resource_type=None, region=None, routes=None, tags=None, vpc_id=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if is_ipv6 and not isinstance(is_ipv6, bool):
+            raise TypeError("Expected argument 'is_ipv6' to be a bool")
+        pulumi.set(__self__, "is_ipv6", is_ipv6)
+        if nexthop_private_network_id and not isinstance(nexthop_private_network_id, str):
+            raise TypeError("Expected argument 'nexthop_private_network_id' to be a str")
+        pulumi.set(__self__, "nexthop_private_network_id", nexthop_private_network_id)
+        if nexthop_resource_id and not isinstance(nexthop_resource_id, str):
+            raise TypeError("Expected argument 'nexthop_resource_id' to be a str")
+        pulumi.set(__self__, "nexthop_resource_id", nexthop_resource_id)
+        if nexthop_resource_type and not isinstance(nexthop_resource_type, str):
+            raise TypeError("Expected argument 'nexthop_resource_type' to be a str")
+        pulumi.set(__self__, "nexthop_resource_type", nexthop_resource_type)
+        if region and not isinstance(region, str):
+            raise TypeError("Expected argument 'region' to be a str")
+        pulumi.set(__self__, "region", region)
+        if routes and not isinstance(routes, list):
+            raise TypeError("Expected argument 'routes' to be a list")
+        pulumi.set(__self__, "routes", routes)
+        if tags and not isinstance(tags, list):
+            raise TypeError("Expected argument 'tags' to be a list")
+        pulumi.set(__self__, "tags", tags)
+        if vpc_id and not isinstance(vpc_id, str):
+            raise TypeError("Expected argument 'vpc_id' to be a str")
+        pulumi.set(__self__, "vpc_id", vpc_id)
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="isIpv6")
+    def is_ipv6(self) -> Optional[bool]:
+        return pulumi.get(self, "is_ipv6")
+
+    @property
+    @pulumi.getter(name="nexthopPrivateNetworkId")
+    def nexthop_private_network_id(self) -> Optional[str]:
+        return pulumi.get(self, "nexthop_private_network_id")
+
+    @property
+    @pulumi.getter(name="nexthopResourceId")
+    def nexthop_resource_id(self) -> Optional[str]:
+        return pulumi.get(self, "nexthop_resource_id")
+
+    @property
+    @pulumi.getter(name="nexthopResourceType")
+    def nexthop_resource_type(self) -> Optional[str]:
+        return pulumi.get(self, "nexthop_resource_type")
+
+    @property
+    @pulumi.getter
+    def region(self) -> str:
+        return pulumi.get(self, "region")
+
+    @property
+    @pulumi.getter
+    def routes(self) -> Sequence['outputs.GetRoutesRouteResult']:
+        """
+        List of retrieved routes
+        """
+        return pulumi.get(self, "routes")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Sequence[str]]:
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter(name="vpcId")
+    def vpc_id(self) -> Optional[str]:
+        return pulumi.get(self, "vpc_id")
+
+
+class AwaitableGetRoutesResult(GetRoutesResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetRoutesResult(
+            id=self.id,
+            is_ipv6=self.is_ipv6,
+            nexthop_private_network_id=self.nexthop_private_network_id,
+            nexthop_resource_id=self.nexthop_resource_id,
+            nexthop_resource_type=self.nexthop_resource_type,
+            region=self.region,
+            routes=self.routes,
+            tags=self.tags,
+            vpc_id=self.vpc_id)
+
+
+def get_routes(is_ipv6: Optional[bool] = None,
+               nexthop_private_network_id: Optional[str] = None,
+               nexthop_resource_id: Optional[str] = None,
+               nexthop_resource_type: Optional[str] = None,
+               region: Optional[str] = None,
+               tags: Optional[Sequence[str]] = None,
+               vpc_id: Optional[str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetRoutesResult:
+    """
+    Gets information about multiple VPC routes.
+
+
+    :param bool is_ipv6: Routes with an IPv6 destination will be listed.
+    :param str nexthop_private_network_id: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
+    :param str nexthop_resource_id: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
+    :param str nexthop_resource_type: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
+    :param str region: `region`). The region in which the routes exist.
+    :param Sequence[str] tags: List of tags to filter for. routes with these exact tags are listed.
+    :param str vpc_id: The VPC ID to filter for. routes with a similar VPC ID are listed.
+    """
+    __args__ = dict()
+    __args__['isIpv6'] = is_ipv6
+    __args__['nexthopPrivateNetworkId'] = nexthop_private_network_id
+    __args__['nexthopResourceId'] = nexthop_resource_id
+    __args__['nexthopResourceType'] = nexthop_resource_type
+    __args__['region'] = region
+    __args__['tags'] = tags
+    __args__['vpcId'] = vpc_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:network/getRoutes:getRoutes', __args__, opts=opts, typ=GetRoutesResult).value
+
+    return AwaitableGetRoutesResult(
+        id=pulumi.get(__ret__, 'id'),
+        is_ipv6=pulumi.get(__ret__, 'is_ipv6'),
+        nexthop_private_network_id=pulumi.get(__ret__, 'nexthop_private_network_id'),
+        nexthop_resource_id=pulumi.get(__ret__, 'nexthop_resource_id'),
+        nexthop_resource_type=pulumi.get(__ret__, 'nexthop_resource_type'),
+        region=pulumi.get(__ret__, 'region'),
+        routes=pulumi.get(__ret__, 'routes'),
+        tags=pulumi.get(__ret__, 'tags'),
+        vpc_id=pulumi.get(__ret__, 'vpc_id'))
+def get_routes_output(is_ipv6: Optional[pulumi.Input[Optional[bool]]] = None,
+                      nexthop_private_network_id: Optional[pulumi.Input[Optional[str]]] = None,
+                      nexthop_resource_id: Optional[pulumi.Input[Optional[str]]] = None,
+                      nexthop_resource_type: Optional[pulumi.Input[Optional[str]]] = None,
+                      region: Optional[pulumi.Input[Optional[str]]] = None,
+                      tags: Optional[pulumi.Input[Optional[Sequence[str]]]] = None,
+                      vpc_id: Optional[pulumi.Input[Optional[str]]] = None,
+                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetRoutesResult]:
+    """
+    Gets information about multiple VPC routes.
+
+
+    :param bool is_ipv6: Routes with an IPv6 destination will be listed.
+    :param str nexthop_private_network_id: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
+    :param str nexthop_resource_id: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
+    :param str nexthop_resource_type: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
+    :param str region: `region`). The region in which the routes exist.
+    :param Sequence[str] tags: List of tags to filter for. routes with these exact tags are listed.
+    :param str vpc_id: The VPC ID to filter for. routes with a similar VPC ID are listed.
+    """
+    __args__ = dict()
+    __args__['isIpv6'] = is_ipv6
+    __args__['nexthopPrivateNetworkId'] = nexthop_private_network_id
+    __args__['nexthopResourceId'] = nexthop_resource_id
+    __args__['nexthopResourceType'] = nexthop_resource_type
+    __args__['region'] = region
+    __args__['tags'] = tags
+    __args__['vpcId'] = vpc_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:network/getRoutes:getRoutes', __args__, opts=opts, typ=GetRoutesResult)
+    return __ret__.apply(lambda __response__: GetRoutesResult(
+        id=pulumi.get(__response__, 'id'),
+        is_ipv6=pulumi.get(__response__, 'is_ipv6'),
+        nexthop_private_network_id=pulumi.get(__response__, 'nexthop_private_network_id'),
+        nexthop_resource_id=pulumi.get(__response__, 'nexthop_resource_id'),
+        nexthop_resource_type=pulumi.get(__response__, 'nexthop_resource_type'),
+        region=pulumi.get(__response__, 'region'),
+        routes=pulumi.get(__response__, 'routes'),
+        tags=pulumi.get(__response__, 'tags'),
+        vpc_id=pulumi.get(__response__, 'vpc_id')))