Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. Gateway
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.Gateway

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

Create a new Gateway for existing subnet in the specified public cloud project.

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,
            model: Optional[str] = None,
            network_id: Optional[str] = None,
            region: Optional[str] = None,
            service_name: Optional[str] = None,
            subnet_id: Optional[str] = None,
            name: 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: ovh:CloudProject: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 Ovh.CloudProject.Gateway("gatewayResource", new()
{
    Model = "string",
    NetworkId = "string",
    Region = "string",
    ServiceName = "string",
    SubnetId = "string",
    Name = "string",
});
Copy
example, err := CloudProject.NewGateway(ctx, "gatewayResource", &CloudProject.GatewayArgs{
	Model:       pulumi.String("string"),
	NetworkId:   pulumi.String("string"),
	Region:      pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	SubnetId:    pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .model("string")
    .networkId("string")
    .region("string")
    .serviceName("string")
    .subnetId("string")
    .name("string")
    .build());
Copy
gateway_resource = ovh.cloud_project.Gateway("gatewayResource",
    model="string",
    network_id="string",
    region="string",
    service_name="string",
    subnet_id="string",
    name="string")
Copy
const gatewayResource = new ovh.cloudproject.Gateway("gatewayResource", {
    model: "string",
    networkId: "string",
    region: "string",
    serviceName: "string",
    subnetId: "string",
    name: "string",
});
Copy
type: ovh:CloudProject:Gateway
properties:
    model: string
    name: string
    networkId: string
    region: string
    serviceName: string
    subnetId: 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:

Model This property is required. string
Model of the gateway.
NetworkId
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
Region
This property is required.
Changes to this property will trigger replacement.
string
Region of the gateway.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
ID of the subnet.
Name string
Name of the gateway.
Model This property is required. string
Model of the gateway.
NetworkId
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
Region
This property is required.
Changes to this property will trigger replacement.
string
Region of the gateway.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
ID of the subnet.
Name string
Name of the gateway.
model This property is required. String
Model of the gateway.
networkId
This property is required.
Changes to this property will trigger replacement.
String
ID of the private network.
region
This property is required.
Changes to this property will trigger replacement.
String
Region of the gateway.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
ID of the private network.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
ID of the subnet.
name String
Name of the gateway.
model This property is required. string
Model of the gateway.
networkId
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
region
This property is required.
Changes to this property will trigger replacement.
string
Region of the gateway.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
ID of the private network.
subnetId
This property is required.
Changes to this property will trigger replacement.
string
ID of the subnet.
name string
Name of the gateway.
model This property is required. str
Model of the gateway.
network_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the private network.
region
This property is required.
Changes to this property will trigger replacement.
str
Region of the gateway.
service_name
This property is required.
Changes to this property will trigger replacement.
str
ID of the private network.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the subnet.
name str
Name of the gateway.
model This property is required. String
Model of the gateway.
networkId
This property is required.
Changes to this property will trigger replacement.
String
ID of the private network.
region
This property is required.
Changes to this property will trigger replacement.
String
Region of the gateway.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
ID of the private network.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
ID of the subnet.
name String
Name of the gateway.

Outputs

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

ExternalInformations List<GatewayExternalInformation>
List of External Information of the gateway.
Id string
The provider-assigned unique ID for this managed resource.
Interfaces List<GatewayInterface>
Interfaces list of the gateway.
Status string
Status of the gateway.
ExternalInformations []GatewayExternalInformation
List of External Information of the gateway.
Id string
The provider-assigned unique ID for this managed resource.
Interfaces []GatewayInterfaceType
Interfaces list of the gateway.
Status string
Status of the gateway.
externalInformations List<GatewayExternalInformation>
List of External Information of the gateway.
id String
The provider-assigned unique ID for this managed resource.
interfaces List<GatewayInterface>
Interfaces list of the gateway.
status String
Status of the gateway.
externalInformations GatewayExternalInformation[]
List of External Information of the gateway.
id string
The provider-assigned unique ID for this managed resource.
interfaces GatewayInterface[]
Interfaces list of the gateway.
status string
Status of the gateway.
external_informations Sequence[cloudproject.GatewayExternalInformation]
List of External Information of the gateway.
id str
The provider-assigned unique ID for this managed resource.
interfaces Sequence[cloudproject.GatewayInterface]
Interfaces list of the gateway.
status str
Status of the gateway.
externalInformations List<Property Map>
List of External Information of the gateway.
id String
The provider-assigned unique ID for this managed resource.
interfaces List<Property Map>
Interfaces list of the gateway.
status String
Status of the gateway.

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,
        external_informations: Optional[Sequence[_cloudproject.GatewayExternalInformationArgs]] = None,
        interfaces: Optional[Sequence[_cloudproject.GatewayInterfaceArgs]] = None,
        model: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        region: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: 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: ovh:CloudProject: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:
ExternalInformations List<GatewayExternalInformation>
List of External Information of the gateway.
Interfaces List<GatewayInterface>
Interfaces list of the gateway.
Model string
Model of the gateway.
Name string
Name of the gateway.
NetworkId Changes to this property will trigger replacement. string
ID of the private network.
Region Changes to this property will trigger replacement. string
Region of the gateway.
ServiceName Changes to this property will trigger replacement. string
ID of the private network.
Status string
Status of the gateway.
SubnetId Changes to this property will trigger replacement. string
ID of the subnet.
ExternalInformations []GatewayExternalInformationArgs
List of External Information of the gateway.
Interfaces []GatewayInterfaceTypeArgs
Interfaces list of the gateway.
Model string
Model of the gateway.
Name string
Name of the gateway.
NetworkId Changes to this property will trigger replacement. string
ID of the private network.
Region Changes to this property will trigger replacement. string
Region of the gateway.
ServiceName Changes to this property will trigger replacement. string
ID of the private network.
Status string
Status of the gateway.
SubnetId Changes to this property will trigger replacement. string
ID of the subnet.
externalInformations List<GatewayExternalInformation>
List of External Information of the gateway.
interfaces List<GatewayInterface>
Interfaces list of the gateway.
model String
Model of the gateway.
name String
Name of the gateway.
networkId Changes to this property will trigger replacement. String
ID of the private network.
region Changes to this property will trigger replacement. String
Region of the gateway.
serviceName Changes to this property will trigger replacement. String
ID of the private network.
status String
Status of the gateway.
subnetId Changes to this property will trigger replacement. String
ID of the subnet.
externalInformations GatewayExternalInformation[]
List of External Information of the gateway.
interfaces GatewayInterface[]
Interfaces list of the gateway.
model string
Model of the gateway.
name string
Name of the gateway.
networkId Changes to this property will trigger replacement. string
ID of the private network.
region Changes to this property will trigger replacement. string
Region of the gateway.
serviceName Changes to this property will trigger replacement. string
ID of the private network.
status string
Status of the gateway.
subnetId Changes to this property will trigger replacement. string
ID of the subnet.
external_informations Sequence[cloudproject.GatewayExternalInformationArgs]
List of External Information of the gateway.
interfaces Sequence[cloudproject.GatewayInterfaceArgs]
Interfaces list of the gateway.
model str
Model of the gateway.
name str
Name of the gateway.
network_id Changes to this property will trigger replacement. str
ID of the private network.
region Changes to this property will trigger replacement. str
Region of the gateway.
service_name Changes to this property will trigger replacement. str
ID of the private network.
status str
Status of the gateway.
subnet_id Changes to this property will trigger replacement. str
ID of the subnet.
externalInformations List<Property Map>
List of External Information of the gateway.
interfaces List<Property Map>
Interfaces list of the gateway.
model String
Model of the gateway.
name String
Name of the gateway.
networkId Changes to this property will trigger replacement. String
ID of the private network.
region Changes to this property will trigger replacement. String
Region of the gateway.
serviceName Changes to this property will trigger replacement. String
ID of the private network.
status String
Status of the gateway.
subnetId Changes to this property will trigger replacement. String
ID of the subnet.

Supporting Types

GatewayExternalInformation
, GatewayExternalInformationArgs

Ips List<GatewayExternalInformationIp>
List of external ips of the gateway.
NetworkId string
ID of the private network.
Ips []GatewayExternalInformationIp
List of external ips of the gateway.
NetworkId string
ID of the private network.
ips List<GatewayExternalInformationIp>
List of external ips of the gateway.
networkId String
ID of the private network.
ips GatewayExternalInformationIp[]
List of external ips of the gateway.
networkId string
ID of the private network.
ips Sequence[cloudproject.GatewayExternalInformationIp]
List of external ips of the gateway.
network_id str
ID of the private network.
ips List<Property Map>
List of external ips of the gateway.
networkId String
ID of the private network.

GatewayExternalInformationIp
, GatewayExternalInformationIpArgs

Ip string
IP of the interface.
SubnetId string
ID of the subnet.
Ip string
IP of the interface.
SubnetId string
ID of the subnet.
ip String
IP of the interface.
subnetId String
ID of the subnet.
ip string
IP of the interface.
subnetId string
ID of the subnet.
ip str
IP of the interface.
subnet_id str
ID of the subnet.
ip String
IP of the interface.
subnetId String
ID of the subnet.

GatewayInterface
, GatewayInterfaceArgs

Id string
ID of the interface.
Ip string
IP of the interface.
NetworkId string
ID of the private network.
SubnetId string
ID of the subnet.
Id string
ID of the interface.
Ip string
IP of the interface.
NetworkId string
ID of the private network.
SubnetId string
ID of the subnet.
id String
ID of the interface.
ip String
IP of the interface.
networkId String
ID of the private network.
subnetId String
ID of the subnet.
id string
ID of the interface.
ip string
IP of the interface.
networkId string
ID of the private network.
subnetId string
ID of the subnet.
id str
ID of the interface.
ip str
IP of the interface.
network_id str
ID of the private network.
subnet_id str
ID of the subnet.
id String
ID of the interface.
ip String
IP of the interface.
networkId String
ID of the private network.
subnetId String
ID of the subnet.

Import

A gateway can be imported using the service_name, region and id (identifier of the gateway) properties, separated by a /.

bash

$ pulumi import ovh:CloudProject/gateway:Gateway gateway service_name/region/id
Copy

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.
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh