getCloudGateway

OVHCloud v2.17.0, Jul 17 26

Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

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

const gateway = ovh.getCloudGateway({
    serviceName: "<public cloud project ID>",
    id: "<gateway ID>",
});
export const gatewayName = gateway.then(gateway => gateway.name);

import pulumi
import pulumi_ovh as ovh

gateway = ovh.get_cloud_gateway(service_name="<public cloud project ID>",
    id="<gateway ID>")
pulumi.export("gatewayName", gateway.name)

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 {
		gateway, err := ovh.LookupCloudGateway(ctx, &ovh.LookupCloudGatewayArgs{
			ServiceName: "<public cloud project ID>",
			Id:          "<gateway ID>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("gatewayName", gateway.Name)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var gateway = Ovh.GetCloudGateway.Invoke(new()
    {
        ServiceName = "<public cloud project ID>",
        Id = "<gateway ID>",
    });

    return new Dictionary<string, object?>
    {
        ["gatewayName"] = gateway.Apply(getCloudGatewayResult => getCloudGatewayResult.Name),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.OvhFunctions;
import com.pulumi.ovh.inputs.GetCloudGatewayArgs;
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) {
        final var gateway = OvhFunctions.getCloudGateway(GetCloudGatewayArgs.builder()
            .serviceName("<public cloud project ID>")
            .id("<gateway ID>")
            .build());

        ctx.export("gatewayName", gateway.name());
    }
}

variables:
  gateway:
    fn::invoke:
      function: ovh:getCloudGateway
      arguments:
        serviceName: <public cloud project ID>
        id: <gateway ID>
outputs:
  gatewayName: ${gateway.name}

Example coming soon!

Using getCloudGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudGateway(args: GetCloudGatewayArgs, opts?: InvokeOptions): Promise<GetCloudGatewayResult>
function getCloudGatewayOutput(args: GetCloudGatewayOutputArgs, opts?: InvokeOptions): Output<GetCloudGatewayResult>

def get_cloud_gateway(id: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCloudGatewayResult
def get_cloud_gateway_output(id: pulumi.Input[Optional[str]] = None,
                      service_name: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCloudGatewayResult]

func LookupCloudGateway(ctx *Context, args *LookupCloudGatewayArgs, opts ...InvokeOption) (*LookupCloudGatewayResult, error)
func LookupCloudGatewayOutput(ctx *Context, args *LookupCloudGatewayOutputArgs, opts ...InvokeOption) LookupCloudGatewayResultOutput

> Note: This function is named LookupCloudGateway in the Go SDK.

public static class GetCloudGateway 
{
    public static Task<GetCloudGatewayResult> InvokeAsync(GetCloudGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudGatewayResult> Invoke(GetCloudGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudGatewayResult> getCloudGateway(GetCloudGatewayArgs args, InvokeOptions options)
public static Output<GetCloudGatewayResult> getCloudGateway(GetCloudGatewayArgs args, InvokeOptions options)

fn::invoke:
  function: ovh:index/getCloudGateway:getCloudGateway
  arguments:
    # arguments dictionary

data "ovh_get_cloud_gateway" "name" {
    # arguments
}

The following arguments are supported:

Id string: Gateway ID.
ServiceName string: Service name of the resource representing the id of the cloud project.

Id string: Gateway ID.
ServiceName string: Service name of the resource representing the id of the cloud project.

id string: Gateway ID.
service_name string: Service name of the resource representing the id of the cloud project.

id String: Gateway ID.
serviceName String: Service name of the resource representing the id of the cloud project.

id string: Gateway ID.
serviceName string: Service name of the resource representing the id of the cloud project.

id str: Gateway ID.
service_name str: Service name of the resource representing the id of the cloud project.

id String: Gateway ID.
serviceName String: Service name of the resource representing the id of the cloud project.