Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. CloudGateway
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudGateway

ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Creates a gateway in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const network = new ovh.CloudNetworkPrivateVrack("network", {
    serviceName: "<public cloud project ID>",
    name: "my-private-network",
    region: "GRA1",
});
const subnet = new ovh.CloudNetworkPrivateVrackSubnet("subnet", {
    serviceName: network.serviceName,
    networkId: network.id,
    name: "my-subnet",
    cidr: "10.0.0.0/24",
    region: "GRA1",
});
const gateway = new ovh.CloudGateway("gateway", {
    serviceName: network.serviceName,
    region: "GRA1",
    name: "my-gateway",
    externalGateway: {
        enabled: true,
        model: "S",
    },
    subnetIds: [subnet.id],
});

    import pulumi
import pulumi_ovh as ovh

network = ovh.CloudNetworkPrivateVrack("network",
    service_name="<public cloud project ID>",
    name="my-private-network",
    region="GRA1")
subnet = ovh.CloudNetworkPrivateVrackSubnet("subnet",
    service_name=network.service_name,
    network_id=network.id,
    name="my-subnet",
    cidr="10.0.0.0/24",
    region="GRA1")
gateway = ovh.CloudGateway("gateway",
    service_name=network.service_name,
    region="GRA1",
    name="my-gateway",
    external_gateway={
        "enabled": True,
        "model": "S",
    },
    subnet_ids=[subnet.id])

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network, err := ovh.NewCloudNetworkPrivateVrack(ctx, "network", &ovh.CloudNetworkPrivateVrackArgs{
			ServiceName: pulumi.String("<public cloud project ID>"),
			Name:        pulumi.String("my-private-network"),
			Region:      pulumi.String("GRA1"),
		})
		if err != nil {
			return err
		}
		subnet, err := ovh.NewCloudNetworkPrivateVrackSubnet(ctx, "subnet", &ovh.CloudNetworkPrivateVrackSubnetArgs{
			ServiceName: network.ServiceName,
			NetworkId:   network.ID(),
			Name:        pulumi.String("my-subnet"),
			Cidr:        pulumi.String("10.0.0.0/24"),
			Region:      pulumi.String("GRA1"),
		})
		if err != nil {
			return err
		}
		_, err = ovh.NewCloudGateway(ctx, "gateway", &ovh.CloudGatewayArgs{
			ServiceName: network.ServiceName,
			Region:      pulumi.String("GRA1"),
			Name:        pulumi.String("my-gateway"),
			ExternalGateway: &ovh.CloudGatewayExternalGatewayArgs{
				Enabled: pulumi.Bool(true),
				Model:   pulumi.String("S"),
			},
			SubnetIds: pulumi.StringArray{
				subnet.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var network = new Ovh.CloudNetworkPrivateVrack("network", new()
    {
        ServiceName = "<public cloud project ID>",
        Name = "my-private-network",
        Region = "GRA1",
    });

    var subnet = new Ovh.CloudNetworkPrivateVrackSubnet("subnet", new()
    {
        ServiceName = network.ServiceName,
        NetworkId = network.Id,
        Name = "my-subnet",
        Cidr = "10.0.0.0/24",
        Region = "GRA1",
    });

    var gateway = new Ovh.CloudGateway("gateway", new()
    {
        ServiceName = network.ServiceName,
        Region = "GRA1",
        Name = "my-gateway",
        ExternalGateway = new Ovh.Inputs.CloudGatewayExternalGatewayArgs
        {
            Enabled = true,
            Model = "S",
        },
        SubnetIds = new[]
        {
            subnet.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudNetworkPrivateVrack;
import com.ovhcloud.pulumi.ovh.CloudNetworkPrivateVrackArgs;
import com.ovhcloud.pulumi.ovh.CloudNetworkPrivateVrackSubnet;
import com.ovhcloud.pulumi.ovh.CloudNetworkPrivateVrackSubnetArgs;
import com.ovhcloud.pulumi.ovh.CloudGateway;
import com.ovhcloud.pulumi.ovh.CloudGatewayArgs;
import com.pulumi.ovh.inputs.CloudGatewayExternalGatewayArgs;
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) {
        var network = new CloudNetworkPrivateVrack("network", CloudNetworkPrivateVrackArgs.builder()
            .serviceName("<public cloud project ID>")
            .name("my-private-network")
            .region("GRA1")
            .build());

        var subnet = new CloudNetworkPrivateVrackSubnet("subnet", CloudNetworkPrivateVrackSubnetArgs.builder()
            .serviceName(network.serviceName())
            .networkId(network.id())
            .name("my-subnet")
            .cidr("10.0.0.0/24")
            .region("GRA1")
            .build());

        var gateway = new CloudGateway("gateway", CloudGatewayArgs.builder()
            .serviceName(network.serviceName())
            .region("GRA1")
            .name("my-gateway")
            .externalGateway(CloudGatewayExternalGatewayArgs.builder()
                .enabled(true)
                .model("S")
                .build())
            .subnetIds(subnet.id())
            .build());

    }
}

    resources:
  network:
    type: ovh:CloudNetworkPrivateVrack
    properties:
      serviceName: <public cloud project ID>
      name: my-private-network
      region: GRA1
  subnet:
    type: ovh:CloudNetworkPrivateVrackSubnet
    properties:
      serviceName: ${network.serviceName}
      networkId: ${network.id}
      name: my-subnet
      cidr: 10.0.0.0/24
      region: GRA1
  gateway:
    type: ovh:CloudGateway
    properties:
      serviceName: ${network.serviceName}
      region: GRA1
      name: my-gateway
      externalGateway:
        enabled: true
        model: S
      subnetIds:
        - ${subnet.id}

    Example coming soon!

    Create CloudGateway Resource

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

    Constructor syntax

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

@overload
def CloudGateway(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 region: Optional[str] = None,
                 service_name: Optional[str] = None,
                 availability_zone: Optional[str] = None,
                 description: Optional[str] = None,
                 external_gateway: Optional[CloudGatewayExternalGatewayArgs] = None,
                 name: Optional[str] = None,
                 subnet_ids: Optional[Sequence[str]] = None)
    func NewCloudGateway(ctx *Context, name string, args CloudGatewayArgs, opts ...ResourceOption) (*CloudGateway, error)
    public CloudGateway(string name, CloudGatewayArgs args, CustomResourceOptions? opts = null)
    public CloudGateway(String name, CloudGatewayArgs args)
public CloudGateway(String name, CloudGatewayArgs args, CustomResourceOptions options)

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


    resource "ovh_cloudgateway" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CloudGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CloudGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CloudGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudGatewayArgs
    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 cloudGatewayResource = new Ovh.CloudGateway("cloudGatewayResource", new()
{
    Region = "string",
    ServiceName = "string",
    AvailabilityZone = "string",
    Description = "string",
    ExternalGateway = new Ovh.Inputs.CloudGatewayExternalGatewayArgs
    {
        Enabled = false,
        Model = "string",
    },
    Name = "string",
    SubnetIds = new[]
    {
        "string",
    },
});

    example, err := ovh.NewCloudGateway(ctx, "cloudGatewayResource", &ovh.CloudGatewayArgs{
	Region:           pulumi.String("string"),
	ServiceName:      pulumi.String("string"),
	AvailabilityZone: pulumi.String("string"),
	Description:      pulumi.String("string"),
	ExternalGateway: &ovh.CloudGatewayExternalGatewayArgs{
		Enabled: pulumi.Bool(false),
		Model:   pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "ovh_cloudgateway" "cloudGatewayResource" {
  region            = "string"
  service_name      = "string"
  availability_zone = "string"
  description       = "string"
  external_gateway = {
    enabled = false
    model   = "string"
  }
  name       = "string"
  subnet_ids = ["string"]
}

    var cloudGatewayResource = new CloudGateway("cloudGatewayResource", CloudGatewayArgs.builder()
    .region("string")
    .serviceName("string")
    .availabilityZone("string")
    .description("string")
    .externalGateway(CloudGatewayExternalGatewayArgs.builder()
        .enabled(false)
        .model("string")
        .build())
    .name("string")
    .subnetIds("string")
    .build());

    cloud_gateway_resource = ovh.CloudGateway("cloudGatewayResource",
    region="string",
    service_name="string",
    availability_zone="string",
    description="string",
    external_gateway={
        "enabled": False,
        "model": "string",
    },
    name="string",
    subnet_ids=["string"])

    const cloudGatewayResource = new ovh.CloudGateway("cloudGatewayResource", {
    region: "string",
    serviceName: "string",
    availabilityZone: "string",
    description: "string",
    externalGateway: {
        enabled: false,
        model: "string",
    },
    name: "string",
    subnetIds: ["string"],
});

    type: ovh:CloudGateway
properties:
    availabilityZone: string
    description: string
    externalGateway:
        enabled: false
        model: string
    name: string
    region: string
    serviceName: string
    subnetIds:
        - string

    CloudGateway 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 CloudGateway resource accepts the following input properties:

    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Description string
    Gateway description.
    ExternalGateway CloudGatewayExternalGateway
    External gateway configuration:
    Name string
    Gateway name.
    SubnetIds List<string>
    List of subnet IDs to attach as router interfaces.
    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Description string
    Gateway description.
    ExternalGateway CloudGatewayExternalGatewayArgs
    External gateway configuration:
    Name string
    Gateway name.
    SubnetIds []string
    List of subnet IDs to attach as router interfaces.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    service_name string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availability_zone string
    Availability zone for the gateway. Changing this value recreates the resource.
    description string
    Gateway description.
    external_gateway object
    External gateway configuration:
    name string
    Gateway name.
    subnet_ids list(string)
    List of subnet IDs to attach as router interfaces.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    description String
    Gateway description.
    externalGateway CloudGatewayExternalGateway
    External gateway configuration:
    name String
    Gateway name.
    subnetIds List<String>
    List of subnet IDs to attach as router interfaces.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    description string
    Gateway description.
    externalGateway CloudGatewayExternalGateway
    External gateway configuration:
    name string
    Gateway name.
    subnetIds string[]
    List of subnet IDs to attach as router interfaces.
    region str
    Region where the gateway will be created. Changing this value recreates the resource.
    service_name str
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availability_zone str
    Availability zone for the gateway. Changing this value recreates the resource.
    description str
    Gateway description.
    external_gateway CloudGatewayExternalGatewayArgs
    External gateway configuration:
    name str
    Gateway name.
    subnet_ids Sequence[str]
    List of subnet IDs to attach as router interfaces.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    description String
    Gateway description.
    externalGateway Property Map
    External gateway configuration:
    name String
    Gateway name.
    subnetIds List<String>
    List of subnet IDs to attach as router interfaces.

    Outputs

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

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState CloudGatewayCurrentState
    Current state of the gateway:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the gateway.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState CloudGatewayCurrentState
    Current state of the gateway:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the gateway.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the gateway.
    current_state object
    Current state of the gateway:
    id string
    The provider-assigned unique ID for this managed resource.
    resource_status string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updated_at string
    Last update date of the gateway.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the gateway.
    currentState CloudGatewayCurrentState
    Current state of the gateway:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the gateway.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the gateway.
    currentState CloudGatewayCurrentState
    Current state of the gateway:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt string
    Last update date of the gateway.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the gateway.
    current_state CloudGatewayCurrentState
    Current state of the gateway:
    id str
    The provider-assigned unique ID for this managed resource.
    resource_status str
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updated_at str
    Last update date of the gateway.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the gateway.
    currentState Property Map
    Current state of the gateway:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the gateway.

    Look up Existing CloudGateway Resource

    Get an existing CloudGateway 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?: CloudGatewayState, opts?: CustomResourceOptions): CloudGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        checksum: Optional[str] = None,
        created_at: Optional[str] = None,
        current_state: Optional[CloudGatewayCurrentStateArgs] = None,
        description: Optional[str] = None,
        external_gateway: Optional[CloudGatewayExternalGatewayArgs] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        resource_status: Optional[str] = None,
        service_name: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> CloudGateway
    func GetCloudGateway(ctx *Context, name string, id IDInput, state *CloudGatewayState, opts ...ResourceOption) (*CloudGateway, error)
    public static CloudGateway Get(string name, Input<string> id, CloudGatewayState? state, CustomResourceOptions? opts = null)
    public static CloudGateway get(String name, Output<String> id, CloudGatewayState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudGateway    get:      id: ${id}
    import {
  to = ovh_cloudgateway.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState CloudGatewayCurrentState
    Current state of the gateway:
    Description string
    Gateway description.
    ExternalGateway CloudGatewayExternalGateway
    External gateway configuration:
    Name string
    Gateway name.
    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    SubnetIds List<string>
    List of subnet IDs to attach as router interfaces.
    UpdatedAt string
    Last update date of the gateway.
    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState CloudGatewayCurrentStateArgs
    Current state of the gateway:
    Description string
    Gateway description.
    ExternalGateway CloudGatewayExternalGatewayArgs
    External gateway configuration:
    Name string
    Gateway name.
    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    SubnetIds []string
    List of subnet IDs to attach as router interfaces.
    UpdatedAt string
    Last update date of the gateway.
    availability_zone string
    Availability zone for the gateway. Changing this value recreates the resource.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the gateway.
    current_state object
    Current state of the gateway:
    description string
    Gateway description.
    external_gateway object
    External gateway configuration:
    name string
    Gateway name.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    resource_status string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    subnet_ids list(string)
    List of subnet IDs to attach as router interfaces.
    updated_at string
    Last update date of the gateway.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the gateway.
    currentState CloudGatewayCurrentState
    Current state of the gateway:
    description String
    Gateway description.
    externalGateway CloudGatewayExternalGateway
    External gateway configuration:
    name String
    Gateway name.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    subnetIds List<String>
    List of subnet IDs to attach as router interfaces.
    updatedAt String
    Last update date of the gateway.
    availabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the gateway.
    currentState CloudGatewayCurrentState
    Current state of the gateway:
    description string
    Gateway description.
    externalGateway CloudGatewayExternalGateway
    External gateway configuration:
    name string
    Gateway name.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    resourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    subnetIds string[]
    List of subnet IDs to attach as router interfaces.
    updatedAt string
    Last update date of the gateway.
    availability_zone str
    Availability zone for the gateway. Changing this value recreates the resource.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the gateway.
    current_state CloudGatewayCurrentStateArgs
    Current state of the gateway:
    description str
    Gateway description.
    external_gateway CloudGatewayExternalGatewayArgs
    External gateway configuration:
    name str
    Gateway name.
    region str
    Region where the gateway will be created. Changing this value recreates the resource.
    resource_status str
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    subnet_ids Sequence[str]
    List of subnet IDs to attach as router interfaces.
    updated_at str
    Last update date of the gateway.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the gateway.
    currentState Property Map
    Current state of the gateway:
    description String
    Gateway description.
    externalGateway Property Map
    External gateway configuration:
    name String
    Gateway name.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    subnetIds List<String>
    List of subnet IDs to attach as router interfaces.
    updatedAt String
    Last update date of the gateway.

    Supporting Types

    CloudGatewayCurrentState, CloudGatewayCurrentStateArgs

    Description string
    Gateway description.
    ExternalGateway CloudGatewayCurrentStateExternalGateway
    External gateway configuration:
    ExternalIp string
    External IP address assigned to the gateway.
    Location CloudGatewayCurrentStateLocation
    Location details:
    Name string
    Gateway name.
    Status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    Subnets List<CloudGatewayCurrentStateSubnet>
    Currently attached subnets:
    Description string
    Gateway description.
    ExternalGateway CloudGatewayCurrentStateExternalGateway
    External gateway configuration:
    ExternalIp string
    External IP address assigned to the gateway.
    Location CloudGatewayCurrentStateLocation
    Location details:
    Name string
    Gateway name.
    Status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    Subnets []CloudGatewayCurrentStateSubnet
    Currently attached subnets:
    description string
    Gateway description.
    external_gateway object
    External gateway configuration:
    external_ip string
    External IP address assigned to the gateway.
    location object
    Location details:
    name string
    Gateway name.
    status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets list(object)
    Currently attached subnets:
    description String
    Gateway description.
    externalGateway CloudGatewayCurrentStateExternalGateway
    External gateway configuration:
    externalIp String
    External IP address assigned to the gateway.
    location CloudGatewayCurrentStateLocation
    Location details:
    name String
    Gateway name.
    status String
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets List<CloudGatewayCurrentStateSubnet>
    Currently attached subnets:
    description string
    Gateway description.
    externalGateway CloudGatewayCurrentStateExternalGateway
    External gateway configuration:
    externalIp string
    External IP address assigned to the gateway.
    location CloudGatewayCurrentStateLocation
    Location details:
    name string
    Gateway name.
    status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets CloudGatewayCurrentStateSubnet[]
    Currently attached subnets:
    description str
    Gateway description.
    external_gateway CloudGatewayCurrentStateExternalGateway
    External gateway configuration:
    external_ip str
    External IP address assigned to the gateway.
    location CloudGatewayCurrentStateLocation
    Location details:
    name str
    Gateway name.
    status str
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets Sequence[CloudGatewayCurrentStateSubnet]
    Currently attached subnets:
    description String
    Gateway description.
    externalGateway Property Map
    External gateway configuration:
    externalIp String
    External IP address assigned to the gateway.
    location Property Map
    Location details:
    name String
    Gateway name.
    status String
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets List<Property Map>
    Currently attached subnets:

    CloudGatewayCurrentStateExternalGateway, CloudGatewayCurrentStateExternalGatewayArgs

    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled bool
    Whether the external gateway is enabled.
    model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled boolean
    Whether the external gateway is enabled.
    model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled bool
    Whether the external gateway is enabled.
    model str
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.

    CloudGatewayCurrentStateLocation, CloudGatewayCurrentStateLocationArgs

    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    Region string
    Region where the gateway will be created. Changing this value recreates the resource.
    availability_zone string
    Availability zone for the gateway. Changing this value recreates the resource.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.
    availabilityZone string
    Availability zone for the gateway. Changing this value recreates the resource.
    region string
    Region where the gateway will be created. Changing this value recreates the resource.
    availability_zone str
    Availability zone for the gateway. Changing this value recreates the resource.
    region str
    Region where the gateway will be created. Changing this value recreates the resource.
    availabilityZone String
    Availability zone for the gateway. Changing this value recreates the resource.
    region String
    Region where the gateway will be created. Changing this value recreates the resource.

    CloudGatewayCurrentStateSubnet, CloudGatewayCurrentStateSubnetArgs

    Id string
    Subnet ID.
    Id string
    Subnet ID.
    id string
    Subnet ID.
    id String
    Subnet ID.
    id string
    Subnet ID.
    id str
    Subnet ID.
    id String
    Subnet ID.

    CloudGatewayExternalGateway, CloudGatewayExternalGatewayArgs

    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled bool
    Whether the external gateway is enabled.
    model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled boolean
    Whether the external gateway is enabled.
    model string
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled bool
    Whether the external gateway is enabled.
    model str
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model (S, M, L, XL, 2XL, 3XL). Required when enabled is true.

    Import

    A cloud gateway can be imported using the service_name and gateway_id, separated by /:

    terraform

    import {

    to = ovh_cloud_gateway.gateway

    id = “<service_name>/<gateway_id>”

    }

    bash

    $ pulumi import ovh:index/cloudGateway:CloudGateway gateway service_name/gateway_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial