Docs Home
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh.CloudProject.GatewayInterface
Explore with Pulumi AI
Create a new Gateway Interface for existing subnet in the specified public cloud project.
Create GatewayInterface Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayInterface(name: string, args: GatewayInterfaceArgs, opts?: CustomResourceOptions);@overload
def GatewayInterface(resource_name: str,
args: GatewayInterfaceInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayInterface(resource_name: str,
opts: Optional[ResourceOptions] = None,
region: Optional[str] = None,
service_name: Optional[str] = None,
subnet_id: Optional[str] = None,
interface_id: Optional[str] = None)func NewGatewayInterface(ctx *Context, name string, args GatewayInterfaceArgs, opts ...ResourceOption) (*GatewayInterface, error)public GatewayInterface(string name, GatewayInterfaceArgs args, CustomResourceOptions? opts = null)
public GatewayInterface(String name, GatewayInterfaceArgs args)
public GatewayInterface(String name, GatewayInterfaceArgs args, CustomResourceOptions options)
type: ovh:CloudProject:GatewayInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayInterfaceArgs
- 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 GatewayInterfaceInitArgs
- 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 GatewayInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayInterfaceArgs
- 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 gatewayInterfaceResource = new Ovh.CloudProject.GatewayInterface("gatewayInterfaceResource", new()
{
Region = "string",
ServiceName = "string",
SubnetId = "string",
InterfaceId = "string",
});
example, err := CloudProject.NewGatewayInterface(ctx, "gatewayInterfaceResource", &CloudProject.GatewayInterfaceArgs{
Region: pulumi.String("string"),
ServiceName: pulumi.String("string"),
SubnetId: pulumi.String("string"),
InterfaceId: pulumi.String("string"),
})
var gatewayInterfaceResource = new GatewayInterface("gatewayInterfaceResource", GatewayInterfaceArgs.builder()
.region("string")
.serviceName("string")
.subnetId("string")
.interfaceId("string")
.build());
gateway_interface_resource = ovh.cloud_project.GatewayInterface("gatewayInterfaceResource",
region="string",
service_name="string",
subnet_id="string",
interface_id="string")
const gatewayInterfaceResource = new ovh.cloudproject.GatewayInterface("gatewayInterfaceResource", {
region: "string",
serviceName: "string",
subnetId: "string",
interfaceId: "string",
});
type: ovh:CloudProject:GatewayInterface
properties:
interfaceId: string
region: string
serviceName: string
subnetId: string
GatewayInterface 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 GatewayInterface resource accepts the following input properties:
- Region string
- Region of the gateway
- Service
Name string - ID of the cloud project
- Subnet
Id string - ID of the subnet to add
- Interface
Id string - ID of the interface
- Region string
- Region of the gateway
- Service
Name string - ID of the cloud project
- Subnet
Id string - ID of the subnet to add
- Interface
Id string - ID of the interface
- region String
- Region of the gateway
- service
Name String - ID of the cloud project
- subnet
Id String - ID of the subnet to add
- interface
Id String - ID of the interface
- region string
- Region of the gateway
- service
Name string - ID of the cloud project
- subnet
Id string - ID of the subnet to add
- interface
Id string - ID of the interface
- region str
- Region of the gateway
- service_
name str - ID of the cloud project
- subnet_
id str - ID of the subnet to add
- interface_
id str - ID of the interface
- region String
- Region of the gateway
- service
Name String - ID of the cloud project
- subnet
Id String - ID of the subnet to add
- interface
Id String - ID of the interface
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayInterface resource produces the following output properties:
- id str
- The provider-assigned unique ID for this managed resource.
- ip str
- IP of the interface
- network_
id str - Network ID of the interface
Look up Existing GatewayInterface Resource
Get an existing GatewayInterface 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?: GatewayInterfaceState, opts?: CustomResourceOptions): GatewayInterface@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
interface_id: Optional[str] = None,
ip: Optional[str] = None,
network_id: Optional[str] = None,
region: Optional[str] = None,
service_name: Optional[str] = None,
subnet_id: Optional[str] = None) -> GatewayInterfacefunc GetGatewayInterface(ctx *Context, name string, id IDInput, state *GatewayInterfaceState, opts ...ResourceOption) (*GatewayInterface, error)public static GatewayInterface Get(string name, Input<string> id, GatewayInterfaceState? state, CustomResourceOptions? opts = null)public static GatewayInterface get(String name, Output<String> id, GatewayInterfaceState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Interface
Id string - ID of the interface
- Ip string
- IP of the interface
- Network
Id string - Network ID of the interface
- Region string
- Region of the gateway
- Service
Name string - ID of the cloud project
- Subnet
Id string - ID of the subnet to add
- Interface
Id string - ID of the interface
- Ip string
- IP of the interface
- Network
Id string - Network ID of the interface
- Region string
- Region of the gateway
- Service
Name string - ID of the cloud project
- Subnet
Id string - ID of the subnet to add
- interface
Id String - ID of the interface
- ip String
- IP of the interface
- network
Id String - Network ID of the interface
- region String
- Region of the gateway
- service
Name String - ID of the cloud project
- subnet
Id String - ID of the subnet to add
- interface
Id string - ID of the interface
- ip string
- IP of the interface
- network
Id string - Network ID of the interface
- region string
- Region of the gateway
- service
Name string - ID of the cloud project
- subnet
Id string - ID of the subnet to add
- interface_
id str - ID of the interface
- ip str
- IP of the interface
- network_
id str - Network ID of the interface
- region str
- Region of the gateway
- service_
name str - ID of the cloud project
- subnet_
id str - ID of the subnet to add
- interface
Id String - ID of the interface
- ip String
- IP of the interface
- network
Id String - Network ID of the interface
- region String
- Region of the gateway
- service
Name String - ID of the cloud project
- subnet
Id String - ID of the subnet to add
Import
A gateway interface can be imported using the service_name, region, id (identifier of the gateway) and interface_id properties, separated by a /.
bash
$ pulumi import ovh:CloudProject/gatewayInterface:GatewayInterface gateway service_name/region/id/interface_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
ovhTerraform Provider.