Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. UpCloud
  3. API Docs
  4. Gateway
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

upcloud.Gateway

Explore with Pulumi AI

UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

Network gateways connect SDN Private Networks to external IP networks.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as upcloud from "@upcloud/pulumi-upcloud";

// Create router for the gateway
const _this = new upcloud.Router("this", {name: "gateway-example-router"});
// Create network for the gateway
const thisNetwork = new upcloud.Network("this", {
    name: "gateway-example-net",
    zone: "pl-waw1",
    ipNetwork: {
        address: "172.16.2.0/24",
        dhcp: true,
        family: "IPv4",
    },
    router: _this.id,
});
const thisGateway = new upcloud.Gateway("this", {
    name: "gateway-example-gw",
    zone: "pl-waw1",
    features: ["nat"],
    router: {
        id: _this.id,
    },
    labels: {
        "managed-by": "terraform",
    },
});
Copy
import pulumi
import pulumi_upcloud as upcloud

# Create router for the gateway
this = upcloud.Router("this", name="gateway-example-router")
# Create network for the gateway
this_network = upcloud.Network("this",
    name="gateway-example-net",
    zone="pl-waw1",
    ip_network={
        "address": "172.16.2.0/24",
        "dhcp": True,
        "family": "IPv4",
    },
    router=this.id)
this_gateway = upcloud.Gateway("this",
    name="gateway-example-gw",
    zone="pl-waw1",
    features=["nat"],
    router={
        "id": this.id,
    },
    labels={
        "managed-by": "terraform",
    })
Copy
package main

import (
	"github.com/UpCloudLtd/pulumi-upcloud/sdk/go/upcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create router for the gateway
		this, err := upcloud.NewRouter(ctx, "this", &upcloud.RouterArgs{
			Name: pulumi.String("gateway-example-router"),
		})
		if err != nil {
			return err
		}
		// Create network for the gateway
		_, err = upcloud.NewNetwork(ctx, "this", &upcloud.NetworkArgs{
			Name: pulumi.String("gateway-example-net"),
			Zone: pulumi.String("pl-waw1"),
			IpNetwork: &upcloud.NetworkIpNetworkArgs{
				Address: pulumi.String("172.16.2.0/24"),
				Dhcp:    pulumi.Bool(true),
				Family:  pulumi.String("IPv4"),
			},
			Router: this.ID(),
		})
		if err != nil {
			return err
		}
		_, err = upcloud.NewGateway(ctx, "this", &upcloud.GatewayArgs{
			Name: pulumi.String("gateway-example-gw"),
			Zone: pulumi.String("pl-waw1"),
			Features: pulumi.StringArray{
				pulumi.String("nat"),
			},
			Router: &upcloud.GatewayRouterArgs{
				Id: this.ID(),
			},
			Labels: pulumi.StringMap{
				"managed-by": pulumi.String("terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using UpCloud = UpCloud.Pulumi.UpCloud;

return await Deployment.RunAsync(() => 
{
    // Create router for the gateway
    var @this = new UpCloud.Router("this", new()
    {
        Name = "gateway-example-router",
    });

    // Create network for the gateway
    var thisNetwork = new UpCloud.Network("this", new()
    {
        Name = "gateway-example-net",
        Zone = "pl-waw1",
        IpNetwork = new UpCloud.Inputs.NetworkIpNetworkArgs
        {
            Address = "172.16.2.0/24",
            Dhcp = true,
            Family = "IPv4",
        },
        Router = @this.Id,
    });

    var thisGateway = new UpCloud.Gateway("this", new()
    {
        Name = "gateway-example-gw",
        Zone = "pl-waw1",
        Features = new[]
        {
            "nat",
        },
        Router = new UpCloud.Inputs.GatewayRouterArgs
        {
            Id = @this.Id,
        },
        Labels = 
        {
            { "managed-by", "terraform" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.upcloud.Router;
import com.pulumi.upcloud.RouterArgs;
import com.pulumi.upcloud.Network;
import com.pulumi.upcloud.NetworkArgs;
import com.pulumi.upcloud.inputs.NetworkIpNetworkArgs;
import com.pulumi.upcloud.Gateway;
import com.pulumi.upcloud.GatewayArgs;
import com.pulumi.upcloud.inputs.GatewayRouterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create router for the gateway
        var this_ = new Router("this", RouterArgs.builder()
            .name("gateway-example-router")
            .build());

        // Create network for the gateway
        var thisNetwork = new Network("thisNetwork", NetworkArgs.builder()
            .name("gateway-example-net")
            .zone("pl-waw1")
            .ipNetwork(NetworkIpNetworkArgs.builder()
                .address("172.16.2.0/24")
                .dhcp(true)
                .family("IPv4")
                .build())
            .router(this_.id())
            .build());

        var thisGateway = new Gateway("thisGateway", GatewayArgs.builder()
            .name("gateway-example-gw")
            .zone("pl-waw1")
            .features("nat")
            .router(GatewayRouterArgs.builder()
                .id(this_.id())
                .build())
            .labels(Map.of("managed-by", "terraform"))
            .build());

    }
}
Copy
resources:
  # Create router for the gateway
  this:
    type: upcloud:Router
    properties:
      name: gateway-example-router
  # Create network for the gateway
  thisNetwork:
    type: upcloud:Network
    name: this
    properties:
      name: gateway-example-net
      zone: pl-waw1
      ipNetwork:
        address: 172.16.2.0/24
        dhcp: true
        family: IPv4
      router: ${this.id}
  thisGateway:
    type: upcloud:Gateway
    name: this
    properties:
      name: gateway-example-gw
      zone: pl-waw1
      features:
        - nat
      router:
        id: ${this.id}
      labels:
        managed-by: terraform
Copy

Create Gateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            features: Optional[Sequence[str]] = None,
            router: Optional[GatewayRouterArgs] = None,
            zone: Optional[str] = None,
            address: Optional[GatewayAddressArgs] = None,
            configured_status: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            plan: Optional[str] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

type: upcloud:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gatewayResource = new UpCloud.Gateway("gatewayResource", new()
{
    Features = new[]
    {
        "string",
    },
    Router = new UpCloud.Inputs.GatewayRouterArgs
    {
        Id = "string",
    },
    Zone = "string",
    Address = new UpCloud.Inputs.GatewayAddressArgs
    {
        Address = "string",
        Name = "string",
    },
    ConfiguredStatus = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Plan = "string",
});
Copy
example, err := upcloud.NewGateway(ctx, "gatewayResource", &upcloud.GatewayArgs{
	Features: pulumi.StringArray{
		pulumi.String("string"),
	},
	Router: &upcloud.GatewayRouterArgs{
		Id: pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
	Address: &upcloud.GatewayAddressArgs{
		Address: pulumi.String("string"),
		Name:    pulumi.String("string"),
	},
	ConfiguredStatus: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Plan: pulumi.String("string"),
})
Copy
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .features("string")
    .router(GatewayRouterArgs.builder()
        .id("string")
        .build())
    .zone("string")
    .address(GatewayAddressArgs.builder()
        .address("string")
        .name("string")
        .build())
    .configuredStatus("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .plan("string")
    .build());
Copy
gateway_resource = upcloud.Gateway("gatewayResource",
    features=["string"],
    router={
        "id": "string",
    },
    zone="string",
    address={
        "address": "string",
        "name": "string",
    },
    configured_status="string",
    labels={
        "string": "string",
    },
    name="string",
    plan="string")
Copy
const gatewayResource = new upcloud.Gateway("gatewayResource", {
    features: ["string"],
    router: {
        id: "string",
    },
    zone: "string",
    address: {
        address: "string",
        name: "string",
    },
    configuredStatus: "string",
    labels: {
        string: "string",
    },
    name: "string",
    plan: "string",
});
Copy
type: upcloud:Gateway
properties:
    address:
        address: string
        name: string
    configuredStatus: string
    features:
        - string
    labels:
        string: string
    name: string
    plan: string
    router:
        id: string
    zone: string
Copy

Gateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Gateway resource accepts the following input properties:

Features
This property is required.
Changes to this property will trigger replacement.
List<string>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
Router
This property is required.
Changes to this property will trigger replacement.
UpCloud.Pulumi.UpCloud.Inputs.GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
Zone
This property is required.
Changes to this property will trigger replacement.
string
Zone in which the gateway will be hosted, e.g. de-fra1.
Address UpCloud.Pulumi.UpCloud.Inputs.GatewayAddress
IP addresses assigned to the gateway.
ConfiguredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
Labels Dictionary<string, string>
User defined key-value pairs to classify the network gateway.
Name string
Gateway name. Needs to be unique within the account.
Plan string
Gateway pricing plan.
Features
This property is required.
Changes to this property will trigger replacement.
[]string
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
Router
This property is required.
Changes to this property will trigger replacement.
GatewayRouterArgs
Attached Router from where traffic is routed towards the network gateway service.
Zone
This property is required.
Changes to this property will trigger replacement.
string
Zone in which the gateway will be hosted, e.g. de-fra1.
Address GatewayAddressArgs
IP addresses assigned to the gateway.
ConfiguredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
Labels map[string]string
User defined key-value pairs to classify the network gateway.
Name string
Gateway name. Needs to be unique within the account.
Plan string
Gateway pricing plan.
features
This property is required.
Changes to this property will trigger replacement.
List<String>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
router
This property is required.
Changes to this property will trigger replacement.
GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
zone
This property is required.
Changes to this property will trigger replacement.
String
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddress
IP addresses assigned to the gateway.
configuredStatus String
The service configured status indicates the service's current intended status. Managed by the customer.
labels Map<String,String>
User defined key-value pairs to classify the network gateway.
name String
Gateway name. Needs to be unique within the account.
plan String
Gateway pricing plan.
features
This property is required.
Changes to this property will trigger replacement.
string[]
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
router
This property is required.
Changes to this property will trigger replacement.
GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
zone
This property is required.
Changes to this property will trigger replacement.
string
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddress
IP addresses assigned to the gateway.
configuredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
labels {[key: string]: string}
User defined key-value pairs to classify the network gateway.
name string
Gateway name. Needs to be unique within the account.
plan string
Gateway pricing plan.
features
This property is required.
Changes to this property will trigger replacement.
Sequence[str]
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
router
This property is required.
Changes to this property will trigger replacement.
GatewayRouterArgs
Attached Router from where traffic is routed towards the network gateway service.
zone
This property is required.
Changes to this property will trigger replacement.
str
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddressArgs
IP addresses assigned to the gateway.
configured_status str
The service configured status indicates the service's current intended status. Managed by the customer.
labels Mapping[str, str]
User defined key-value pairs to classify the network gateway.
name str
Gateway name. Needs to be unique within the account.
plan str
Gateway pricing plan.
features
This property is required.
Changes to this property will trigger replacement.
List<String>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
router
This property is required.
Changes to this property will trigger replacement.
Property Map
Attached Router from where traffic is routed towards the network gateway service.
zone
This property is required.
Changes to this property will trigger replacement.
String
Zone in which the gateway will be hosted, e.g. de-fra1.
address Property Map
IP addresses assigned to the gateway.
configuredStatus String
The service configured status indicates the service's current intended status. Managed by the customer.
labels Map<String>
User defined key-value pairs to classify the network gateway.
name String
Gateway name. Needs to be unique within the account.
plan String
Gateway pricing plan.

Outputs

All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:

Addresses List<UpCloud.Pulumi.UpCloud.Outputs.GatewayAddress>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

Connections List<string>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
Id string
The provider-assigned unique ID for this managed resource.
OperationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
Addresses []GatewayAddress
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

Connections []string
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
Id string
The provider-assigned unique ID for this managed resource.
OperationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
addresses List<GatewayAddress>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

connections List<String>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
id String
The provider-assigned unique ID for this managed resource.
operationalState String
The service operational state indicates the service's current operational, effective state. Managed by the system.
addresses GatewayAddress[]
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

connections string[]
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
id string
The provider-assigned unique ID for this managed resource.
operationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
addresses Sequence[GatewayAddress]
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

connections Sequence[str]
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
id str
The provider-assigned unique ID for this managed resource.
operational_state str
The service operational state indicates the service's current operational, effective state. Managed by the system.
addresses List<Property Map>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

connections List<String>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
id String
The provider-assigned unique ID for this managed resource.
operationalState String
The service operational state indicates the service's current operational, effective state. Managed by the system.

Look up Existing Gateway Resource

Get an existing Gateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayState, opts?: CustomResourceOptions): Gateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[GatewayAddressArgs] = None,
        addresses: Optional[Sequence[GatewayAddressArgs]] = None,
        configured_status: Optional[str] = None,
        connections: Optional[Sequence[str]] = None,
        features: Optional[Sequence[str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        operational_state: Optional[str] = None,
        plan: Optional[str] = None,
        router: Optional[GatewayRouterArgs] = None,
        zone: Optional[str] = None) -> Gateway
func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
resources:  _:    type: upcloud:Gateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Address UpCloud.Pulumi.UpCloud.Inputs.GatewayAddress
IP addresses assigned to the gateway.
Addresses List<UpCloud.Pulumi.UpCloud.Inputs.GatewayAddress>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

ConfiguredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
Connections List<string>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
Features Changes to this property will trigger replacement. List<string>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
Labels Dictionary<string, string>
User defined key-value pairs to classify the network gateway.
Name string
Gateway name. Needs to be unique within the account.
OperationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
Plan string
Gateway pricing plan.
Router Changes to this property will trigger replacement. UpCloud.Pulumi.UpCloud.Inputs.GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
Zone Changes to this property will trigger replacement. string
Zone in which the gateway will be hosted, e.g. de-fra1.
Address GatewayAddressArgs
IP addresses assigned to the gateway.
Addresses []GatewayAddressArgs
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

ConfiguredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
Connections []string
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
Features Changes to this property will trigger replacement. []string
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
Labels map[string]string
User defined key-value pairs to classify the network gateway.
Name string
Gateway name. Needs to be unique within the account.
OperationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
Plan string
Gateway pricing plan.
Router Changes to this property will trigger replacement. GatewayRouterArgs
Attached Router from where traffic is routed towards the network gateway service.
Zone Changes to this property will trigger replacement. string
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddress
IP addresses assigned to the gateway.
addresses List<GatewayAddress>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

configuredStatus String
The service configured status indicates the service's current intended status. Managed by the customer.
connections List<String>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
features Changes to this property will trigger replacement. List<String>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
labels Map<String,String>
User defined key-value pairs to classify the network gateway.
name String
Gateway name. Needs to be unique within the account.
operationalState String
The service operational state indicates the service's current operational, effective state. Managed by the system.
plan String
Gateway pricing plan.
router Changes to this property will trigger replacement. GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
zone Changes to this property will trigger replacement. String
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddress
IP addresses assigned to the gateway.
addresses GatewayAddress[]
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

configuredStatus string
The service configured status indicates the service's current intended status. Managed by the customer.
connections string[]
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
features Changes to this property will trigger replacement. string[]
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
labels {[key: string]: string}
User defined key-value pairs to classify the network gateway.
name string
Gateway name. Needs to be unique within the account.
operationalState string
The service operational state indicates the service's current operational, effective state. Managed by the system.
plan string
Gateway pricing plan.
router Changes to this property will trigger replacement. GatewayRouter
Attached Router from where traffic is routed towards the network gateway service.
zone Changes to this property will trigger replacement. string
Zone in which the gateway will be hosted, e.g. de-fra1.
address GatewayAddressArgs
IP addresses assigned to the gateway.
addresses Sequence[GatewayAddressArgs]
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

configured_status str
The service configured status indicates the service's current intended status. Managed by the customer.
connections Sequence[str]
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
features Changes to this property will trigger replacement. Sequence[str]
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
labels Mapping[str, str]
User defined key-value pairs to classify the network gateway.
name str
Gateway name. Needs to be unique within the account.
operational_state str
The service operational state indicates the service's current operational, effective state. Managed by the system.
plan str
Gateway pricing plan.
router Changes to this property will trigger replacement. GatewayRouterArgs
Attached Router from where traffic is routed towards the network gateway service.
zone Changes to this property will trigger replacement. str
Zone in which the gateway will be hosted, e.g. de-fra1.
address Property Map
IP addresses assigned to the gateway.
addresses List<Property Map>
IP addresses assigned to the gateway.

Deprecated: Use 'address' attribute instead. This attribute will be removed in the next major version of the provider

configuredStatus String
The service configured status indicates the service's current intended status. Managed by the customer.
connections List<String>
Names of connections attached to the gateway. Note that this field can have outdated information as connections are created by a separate resource. To make sure that you have the most recent data run 'terrafrom refresh'.
features Changes to this property will trigger replacement. List<String>
Features enabled for the gateway. Note that VPN feature is currently in beta, for more details see https://upcloud.com/resources/docs/networking#nat-and-vpn-gateways.
labels Map<String>
User defined key-value pairs to classify the network gateway.
name String
Gateway name. Needs to be unique within the account.
operationalState String
The service operational state indicates the service's current operational, effective state. Managed by the system.
plan String
Gateway pricing plan.
router Changes to this property will trigger replacement. Property Map
Attached Router from where traffic is routed towards the network gateway service.
zone Changes to this property will trigger replacement. String
Zone in which the gateway will be hosted, e.g. de-fra1.

Supporting Types

GatewayAddress
, GatewayAddressArgs

Address string
IP addresss
Name string
Name of the IP address
Address string
IP addresss
Name string
Name of the IP address
address String
IP addresss
name String
Name of the IP address
address string
IP addresss
name string
Name of the IP address
address str
IP addresss
name str
Name of the IP address
address String
IP addresss
name String
Name of the IP address

GatewayRouter
, GatewayRouterArgs

Id This property is required. string
ID of the router attached to the gateway.
Id This property is required. string
ID of the router attached to the gateway.
id This property is required. String
ID of the router attached to the gateway.
id This property is required. string
ID of the router attached to the gateway.
id This property is required. str
ID of the router attached to the gateway.
id This property is required. String
ID of the router attached to the gateway.

Package Details

Repository
upcloud UpCloudLtd/pulumi-upcloud
License
Apache-2.0
Notes
This Pulumi package is based on the upcloud Terraform Provider.
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud