1. Packages
  2. Vkcs Provider
  3. API Docs
  4. NetworkingRouterInterface
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.NetworkingRouterInterface

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

    Manages a router interface resource within VKCS.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vkcs from "@pulumi/vkcs";
    
    const app = new vkcs.NetworkingRouterInterface("app", {
        routerId: vkcs_networking_router.router.id,
        subnetId: vkcs_networking_subnet.app.id,
    });
    
    import pulumi
    import pulumi_vkcs as vkcs
    
    app = vkcs.NetworkingRouterInterface("app",
        router_id=vkcs_networking_router["router"]["id"],
        subnet_id=vkcs_networking_subnet["app"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vkcs.NewNetworkingRouterInterface(ctx, "app", &vkcs.NetworkingRouterInterfaceArgs{
    			RouterId: pulumi.Any(vkcs_networking_router.Router.Id),
    			SubnetId: pulumi.Any(vkcs_networking_subnet.App.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vkcs = Pulumi.Vkcs;
    
    return await Deployment.RunAsync(() => 
    {
        var app = new Vkcs.NetworkingRouterInterface("app", new()
        {
            RouterId = vkcs_networking_router.Router.Id,
            SubnetId = vkcs_networking_subnet.App.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vkcs.NetworkingRouterInterface;
    import com.pulumi.vkcs.NetworkingRouterInterfaceArgs;
    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 app = new NetworkingRouterInterface("app", NetworkingRouterInterfaceArgs.builder()
                .routerId(vkcs_networking_router.router().id())
                .subnetId(vkcs_networking_subnet.app().id())
                .build());
    
        }
    }
    
    resources:
      app:
        type: vkcs:NetworkingRouterInterface
        properties:
          routerId: ${vkcs_networking_router.router.id}
          subnetId: ${vkcs_networking_subnet.app.id}
    

    Create NetworkingRouterInterface Resource

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

    Constructor syntax

    new NetworkingRouterInterface(name: string, args: NetworkingRouterInterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkingRouterInterface(resource_name: str,
                                  args: NetworkingRouterInterfaceArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkingRouterInterface(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  router_id: Optional[str] = None,
                                  networking_router_interface_id: Optional[str] = None,
                                  port_id: Optional[str] = None,
                                  region: Optional[str] = None,
                                  sdn: Optional[str] = None,
                                  subnet_id: Optional[str] = None,
                                  timeouts: Optional[NetworkingRouterInterfaceTimeoutsArgs] = None)
    func NewNetworkingRouterInterface(ctx *Context, name string, args NetworkingRouterInterfaceArgs, opts ...ResourceOption) (*NetworkingRouterInterface, error)
    public NetworkingRouterInterface(string name, NetworkingRouterInterfaceArgs args, CustomResourceOptions? opts = null)
    public NetworkingRouterInterface(String name, NetworkingRouterInterfaceArgs args)
    public NetworkingRouterInterface(String name, NetworkingRouterInterfaceArgs args, CustomResourceOptions options)
    
    type: vkcs:NetworkingRouterInterface
    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 NetworkingRouterInterfaceArgs
    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 NetworkingRouterInterfaceArgs
    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 NetworkingRouterInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkingRouterInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkingRouterInterfaceArgs
    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 networkingRouterInterfaceResource = new Vkcs.NetworkingRouterInterface("networkingRouterInterfaceResource", new()
    {
        RouterId = "string",
        NetworkingRouterInterfaceId = "string",
        PortId = "string",
        Region = "string",
        Sdn = "string",
        SubnetId = "string",
        Timeouts = new Vkcs.Inputs.NetworkingRouterInterfaceTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
    });
    
    example, err := vkcs.NewNetworkingRouterInterface(ctx, "networkingRouterInterfaceResource", &vkcs.NetworkingRouterInterfaceArgs{
    	RouterId:                    pulumi.String("string"),
    	NetworkingRouterInterfaceId: pulumi.String("string"),
    	PortId:                      pulumi.String("string"),
    	Region:                      pulumi.String("string"),
    	Sdn:                         pulumi.String("string"),
    	SubnetId:                    pulumi.String("string"),
    	Timeouts: &vkcs.NetworkingRouterInterfaceTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    })
    
    var networkingRouterInterfaceResource = new NetworkingRouterInterface("networkingRouterInterfaceResource", NetworkingRouterInterfaceArgs.builder()
        .routerId("string")
        .networkingRouterInterfaceId("string")
        .portId("string")
        .region("string")
        .sdn("string")
        .subnetId("string")
        .timeouts(NetworkingRouterInterfaceTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .build());
    
    networking_router_interface_resource = vkcs.NetworkingRouterInterface("networkingRouterInterfaceResource",
        router_id="string",
        networking_router_interface_id="string",
        port_id="string",
        region="string",
        sdn="string",
        subnet_id="string",
        timeouts={
            "create": "string",
            "delete": "string",
        })
    
    const networkingRouterInterfaceResource = new vkcs.NetworkingRouterInterface("networkingRouterInterfaceResource", {
        routerId: "string",
        networkingRouterInterfaceId: "string",
        portId: "string",
        region: "string",
        sdn: "string",
        subnetId: "string",
        timeouts: {
            create: "string",
            "delete": "string",
        },
    });
    
    type: vkcs:NetworkingRouterInterface
    properties:
        networkingRouterInterfaceId: string
        portId: string
        region: string
        routerId: string
        sdn: string
        subnetId: string
        timeouts:
            create: string
            delete: string
    

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

    RouterId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    NetworkingRouterInterfaceId string
    string → ID of the resource.
    PortId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    Region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    SubnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    Timeouts NetworkingRouterInterfaceTimeouts
    RouterId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    NetworkingRouterInterfaceId string
    string → ID of the resource.
    PortId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    Region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    SubnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    Timeouts NetworkingRouterInterfaceTimeoutsArgs
    routerId String
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    networkingRouterInterfaceId String
    string → ID of the resource.
    portId String
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region String
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId String
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeouts
    routerId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    networkingRouterInterfaceId string
    string → ID of the resource.
    portId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeouts
    router_id str
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    networking_router_interface_id str
    string → ID of the resource.
    port_id str
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region str
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    sdn str
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnet_id str
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeoutsArgs
    routerId String
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    networkingRouterInterfaceId String
    string → ID of the resource.
    portId String
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region String
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId String
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NetworkingRouterInterface Resource

    Get an existing NetworkingRouterInterface 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?: NetworkingRouterInterfaceState, opts?: CustomResourceOptions): NetworkingRouterInterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            networking_router_interface_id: Optional[str] = None,
            port_id: Optional[str] = None,
            region: Optional[str] = None,
            router_id: Optional[str] = None,
            sdn: Optional[str] = None,
            subnet_id: Optional[str] = None,
            timeouts: Optional[NetworkingRouterInterfaceTimeoutsArgs] = None) -> NetworkingRouterInterface
    func GetNetworkingRouterInterface(ctx *Context, name string, id IDInput, state *NetworkingRouterInterfaceState, opts ...ResourceOption) (*NetworkingRouterInterface, error)
    public static NetworkingRouterInterface Get(string name, Input<string> id, NetworkingRouterInterfaceState? state, CustomResourceOptions? opts = null)
    public static NetworkingRouterInterface get(String name, Output<String> id, NetworkingRouterInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: vkcs:NetworkingRouterInterface    get:      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:
    NetworkingRouterInterfaceId string
    string → ID of the resource.
    PortId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    Region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    RouterId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    SubnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    Timeouts NetworkingRouterInterfaceTimeouts
    NetworkingRouterInterfaceId string
    string → ID of the resource.
    PortId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    Region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    RouterId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    SubnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    Timeouts NetworkingRouterInterfaceTimeoutsArgs
    networkingRouterInterfaceId String
    string → ID of the resource.
    portId String
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region String
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    routerId String
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId String
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeouts
    networkingRouterInterfaceId string
    string → ID of the resource.
    portId string
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region string
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    routerId string
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId string
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeouts
    networking_router_interface_id str
    string → ID of the resource.
    port_id str
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region str
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    router_id str
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    sdn str
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnet_id str
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts NetworkingRouterInterfaceTimeoutsArgs
    networkingRouterInterfaceId String
    string → ID of the resource.
    portId String
    optional string → ID of the port this interface connects to. Changing this creates a new router interface.
    region String
    optional string → The region in which to obtain the networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.
    routerId String
    required string → ID of the router this interface belongs to. Changing this creates a new router interface.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    subnetId String
    optional string → ID of the subnet this interface connects to. Changing this creates a new router interface.
    timeouts Property Map

    Supporting Types

    NetworkingRouterInterfaceTimeouts, NetworkingRouterInterfaceTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    Router Interfaces can be imported using the port id, e.g.

    openstack port list –router

    $ pulumi import vkcs:index/networkingRouterInterface:NetworkingRouterInterface int_1 <port id from above output>
    

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

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs