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

vkcs.NetworkingRouter

Explore with Pulumi AI

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

    Manages a router resource within VKCS.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vkcs from "@pulumi/vkcs";
    
    const router = new vkcs.NetworkingRouter("router", {
        externalNetworkId: data.vkcs_networking_network.extnet.id,
        tags: ["tf-example"],
    });
    
    import pulumi
    import pulumi_vkcs as vkcs
    
    router = vkcs.NetworkingRouter("router",
        external_network_id=data["vkcs_networking_network"]["extnet"]["id"],
        tags=["tf-example"])
    
    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.NewNetworkingRouter(ctx, "router", &vkcs.NetworkingRouterArgs{
    			ExternalNetworkId: pulumi.Any(data.Vkcs_networking_network.Extnet.Id),
    			Tags: pulumi.StringArray{
    				pulumi.String("tf-example"),
    			},
    		})
    		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 router = new Vkcs.NetworkingRouter("router", new()
        {
            ExternalNetworkId = data.Vkcs_networking_network.Extnet.Id,
            Tags = new[]
            {
                "tf-example",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vkcs.NetworkingRouter;
    import com.pulumi.vkcs.NetworkingRouterArgs;
    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 router = new NetworkingRouter("router", NetworkingRouterArgs.builder()
                .externalNetworkId(data.vkcs_networking_network().extnet().id())
                .tags("tf-example")
                .build());
    
        }
    }
    
    resources:
      router:
        type: vkcs:NetworkingRouter
        properties:
          # Connect router to Internet
          externalNetworkId: ${data.vkcs_networking_network.extnet.id}
          tags:
            - tf-example
    

    Create NetworkingRouter Resource

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

    Constructor syntax

    new NetworkingRouter(name: string, args?: NetworkingRouterArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkingRouter(resource_name: str,
                         args: Optional[NetworkingRouterArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkingRouter(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         admin_state_up: Optional[bool] = None,
                         description: Optional[str] = None,
                         external_network_id: Optional[str] = None,
                         name: Optional[str] = None,
                         networking_router_id: Optional[str] = None,
                         region: Optional[str] = None,
                         sdn: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None,
                         timeouts: Optional[NetworkingRouterTimeoutsArgs] = None,
                         value_specs: Optional[Mapping[str, str]] = None,
                         vendor_options: Optional[NetworkingRouterVendorOptionsArgs] = None)
    func NewNetworkingRouter(ctx *Context, name string, args *NetworkingRouterArgs, opts ...ResourceOption) (*NetworkingRouter, error)
    public NetworkingRouter(string name, NetworkingRouterArgs? args = null, CustomResourceOptions? opts = null)
    public NetworkingRouter(String name, NetworkingRouterArgs args)
    public NetworkingRouter(String name, NetworkingRouterArgs args, CustomResourceOptions options)
    
    type: vkcs:NetworkingRouter
    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 NetworkingRouterArgs
    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 NetworkingRouterArgs
    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 NetworkingRouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkingRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkingRouterArgs
    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 networkingRouterResource = new Vkcs.NetworkingRouter("networkingRouterResource", new()
    {
        AdminStateUp = false,
        Description = "string",
        ExternalNetworkId = "string",
        Name = "string",
        NetworkingRouterId = "string",
        Region = "string",
        Sdn = "string",
        Tags = new[]
        {
            "string",
        },
        Timeouts = new Vkcs.Inputs.NetworkingRouterTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
        ValueSpecs = 
        {
            { "string", "string" },
        },
        VendorOptions = new Vkcs.Inputs.NetworkingRouterVendorOptionsArgs
        {
            SetRouterGatewayAfterCreate = false,
        },
    });
    
    example, err := vkcs.NewNetworkingRouter(ctx, "networkingRouterResource", &vkcs.NetworkingRouterArgs{
    	AdminStateUp:       pulumi.Bool(false),
    	Description:        pulumi.String("string"),
    	ExternalNetworkId:  pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	NetworkingRouterId: pulumi.String("string"),
    	Region:             pulumi.String("string"),
    	Sdn:                pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Timeouts: &vkcs.NetworkingRouterTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    	ValueSpecs: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	VendorOptions: &vkcs.NetworkingRouterVendorOptionsArgs{
    		SetRouterGatewayAfterCreate: pulumi.Bool(false),
    	},
    })
    
    var networkingRouterResource = new NetworkingRouter("networkingRouterResource", NetworkingRouterArgs.builder()
        .adminStateUp(false)
        .description("string")
        .externalNetworkId("string")
        .name("string")
        .networkingRouterId("string")
        .region("string")
        .sdn("string")
        .tags("string")
        .timeouts(NetworkingRouterTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .valueSpecs(Map.of("string", "string"))
        .vendorOptions(NetworkingRouterVendorOptionsArgs.builder()
            .setRouterGatewayAfterCreate(false)
            .build())
        .build());
    
    networking_router_resource = vkcs.NetworkingRouter("networkingRouterResource",
        admin_state_up=False,
        description="string",
        external_network_id="string",
        name="string",
        networking_router_id="string",
        region="string",
        sdn="string",
        tags=["string"],
        timeouts={
            "create": "string",
            "delete": "string",
        },
        value_specs={
            "string": "string",
        },
        vendor_options={
            "set_router_gateway_after_create": False,
        })
    
    const networkingRouterResource = new vkcs.NetworkingRouter("networkingRouterResource", {
        adminStateUp: false,
        description: "string",
        externalNetworkId: "string",
        name: "string",
        networkingRouterId: "string",
        region: "string",
        sdn: "string",
        tags: ["string"],
        timeouts: {
            create: "string",
            "delete": "string",
        },
        valueSpecs: {
            string: "string",
        },
        vendorOptions: {
            setRouterGatewayAfterCreate: false,
        },
    });
    
    type: vkcs:NetworkingRouter
    properties:
        adminStateUp: false
        description: string
        externalNetworkId: string
        name: string
        networkingRouterId: string
        region: string
        sdn: string
        tags:
            - string
        timeouts:
            create: string
            delete: string
        valueSpecs:
            string: string
        vendorOptions:
            setRouterGatewayAfterCreate: false
    

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

    AdminStateUp bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    Description string
    optional string → Human-readable description for the router.
    ExternalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    Name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    NetworkingRouterId string
    string → ID of the resource.
    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.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    Tags List<string>
    optional set of string → A set of string tags for the router.
    Timeouts NetworkingRouterTimeouts
    ValueSpecs Dictionary<string, string>
    optional map of string → Map of additional driver-specific options.
    VendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    AdminStateUp bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    Description string
    optional string → Human-readable description for the router.
    ExternalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    Name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    NetworkingRouterId string
    string → ID of the resource.
    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.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    Tags []string
    optional set of string → A set of string tags for the router.
    Timeouts NetworkingRouterTimeoutsArgs
    ValueSpecs map[string]string
    optional map of string → Map of additional driver-specific options.
    VendorOptions NetworkingRouterVendorOptionsArgs
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp Boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    description String
    optional string → Human-readable description for the router.
    externalNetworkId String
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name String
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId String
    string → ID of the resource.
    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.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags List<String>
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeouts
    valueSpecs Map<String,String>
    optional map of string → Map of additional driver-specific options.
    vendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    description string
    optional string → Human-readable description for the router.
    externalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId string
    string → ID of the resource.
    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.
    sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags string[]
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeouts
    valueSpecs {[key: string]: string}
    optional map of string → Map of additional driver-specific options.
    vendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    admin_state_up bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    description str
    optional string → Human-readable description for the router.
    external_network_id str
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name str
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networking_router_id str
    string → ID of the resource.
    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.
    sdn str
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags Sequence[str]
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeoutsArgs
    value_specs Mapping[str, str]
    optional map of string → Map of additional driver-specific options.
    vendor_options NetworkingRouterVendorOptionsArgs
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp Boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    description String
    optional string → Human-readable description for the router.
    externalNetworkId String
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name String
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId String
    string → ID of the resource.
    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.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags List<String>
    optional set of string → A set of string tags for the router.
    timeouts Property Map
    valueSpecs Map<String>
    optional map of string → Map of additional driver-specific options.
    vendorOptions Property Map
    optional → Map of additional vendor-specific options. Supported options are described below.

    Outputs

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

    AllTags List<string>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    ExternalFixedIps List<NetworkingRouterExternalFixedIp>
    object → List of external gateways of the router.New since v0.7.4.
    Id string
    The provider-assigned unique ID for this managed resource.
    AllTags []string
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    ExternalFixedIps []NetworkingRouterExternalFixedIp
    object → List of external gateways of the router.New since v0.7.4.
    Id string
    The provider-assigned unique ID for this managed resource.
    allTags List<String>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    externalFixedIps List<NetworkingRouterExternalFixedIp>
    object → List of external gateways of the router.New since v0.7.4.
    id String
    The provider-assigned unique ID for this managed resource.
    allTags string[]
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    externalFixedIps NetworkingRouterExternalFixedIp[]
    object → List of external gateways of the router.New since v0.7.4.
    id string
    The provider-assigned unique ID for this managed resource.
    all_tags Sequence[str]
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    external_fixed_ips Sequence[NetworkingRouterExternalFixedIp]
    object → List of external gateways of the router.New since v0.7.4.
    id str
    The provider-assigned unique ID for this managed resource.
    allTags List<String>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    externalFixedIps List<Property Map>
    object → List of external gateways of the router.New since v0.7.4.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NetworkingRouter Resource

    Get an existing NetworkingRouter 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?: NetworkingRouterState, opts?: CustomResourceOptions): NetworkingRouter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            admin_state_up: Optional[bool] = None,
            all_tags: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            external_fixed_ips: Optional[Sequence[NetworkingRouterExternalFixedIpArgs]] = None,
            external_network_id: Optional[str] = None,
            name: Optional[str] = None,
            networking_router_id: Optional[str] = None,
            region: Optional[str] = None,
            sdn: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            timeouts: Optional[NetworkingRouterTimeoutsArgs] = None,
            value_specs: Optional[Mapping[str, str]] = None,
            vendor_options: Optional[NetworkingRouterVendorOptionsArgs] = None) -> NetworkingRouter
    func GetNetworkingRouter(ctx *Context, name string, id IDInput, state *NetworkingRouterState, opts ...ResourceOption) (*NetworkingRouter, error)
    public static NetworkingRouter Get(string name, Input<string> id, NetworkingRouterState? state, CustomResourceOptions? opts = null)
    public static NetworkingRouter get(String name, Output<String> id, NetworkingRouterState state, CustomResourceOptions options)
    resources:  _:    type: vkcs:NetworkingRouter    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:
    AdminStateUp bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    AllTags List<string>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    Description string
    optional string → Human-readable description for the router.
    ExternalFixedIps List<NetworkingRouterExternalFixedIp>
    object → List of external gateways of the router.New since v0.7.4.
    ExternalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    Name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    NetworkingRouterId string
    string → ID of the resource.
    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.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    Tags List<string>
    optional set of string → A set of string tags for the router.
    Timeouts NetworkingRouterTimeouts
    ValueSpecs Dictionary<string, string>
    optional map of string → Map of additional driver-specific options.
    VendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    AdminStateUp bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    AllTags []string
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    Description string
    optional string → Human-readable description for the router.
    ExternalFixedIps []NetworkingRouterExternalFixedIpArgs
    object → List of external gateways of the router.New since v0.7.4.
    ExternalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    Name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    NetworkingRouterId string
    string → ID of the resource.
    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.
    Sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    Tags []string
    optional set of string → A set of string tags for the router.
    Timeouts NetworkingRouterTimeoutsArgs
    ValueSpecs map[string]string
    optional map of string → Map of additional driver-specific options.
    VendorOptions NetworkingRouterVendorOptionsArgs
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp Boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    allTags List<String>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    description String
    optional string → Human-readable description for the router.
    externalFixedIps List<NetworkingRouterExternalFixedIp>
    object → List of external gateways of the router.New since v0.7.4.
    externalNetworkId String
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name String
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId String
    string → ID of the resource.
    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.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags List<String>
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeouts
    valueSpecs Map<String,String>
    optional map of string → Map of additional driver-specific options.
    vendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    allTags string[]
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    description string
    optional string → Human-readable description for the router.
    externalFixedIps NetworkingRouterExternalFixedIp[]
    object → List of external gateways of the router.New since v0.7.4.
    externalNetworkId string
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name string
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId string
    string → ID of the resource.
    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.
    sdn string
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags string[]
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeouts
    valueSpecs {[key: string]: string}
    optional map of string → Map of additional driver-specific options.
    vendorOptions NetworkingRouterVendorOptions
    optional → Map of additional vendor-specific options. Supported options are described below.
    admin_state_up bool
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    all_tags Sequence[str]
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    description str
    optional string → Human-readable description for the router.
    external_fixed_ips Sequence[NetworkingRouterExternalFixedIpArgs]
    object → List of external gateways of the router.New since v0.7.4.
    external_network_id str
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name str
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networking_router_id str
    string → ID of the resource.
    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.
    sdn str
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags Sequence[str]
    optional set of string → A set of string tags for the router.
    timeouts NetworkingRouterTimeoutsArgs
    value_specs Mapping[str, str]
    optional map of string → Map of additional driver-specific options.
    vendor_options NetworkingRouterVendorOptionsArgs
    optional → Map of additional vendor-specific options. Supported options are described below.
    adminStateUp Boolean
    optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
    allTags List<String>
    set of string → The collection of tags assigned on the router, which have been explicitly and implicitly added.
    description String
    optional string → Human-readable description for the router.
    externalFixedIps List<Property Map>
    object → List of external gateways of the router.New since v0.7.4.
    externalNetworkId String
    optional string → The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
    name String
    optional string → A unique name for the router. Changing this updates the name of an existing router.
    networkingRouterId String
    string → ID of the resource.
    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.
    sdn String
    optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
    tags List<String>
    optional set of string → A set of string tags for the router.
    timeouts Property Map
    valueSpecs Map<String>
    optional map of string → Map of additional driver-specific options.
    vendorOptions Property Map
    optional → Map of additional vendor-specific options. Supported options are described below.

    Supporting Types

    NetworkingRouterExternalFixedIp, NetworkingRouterExternalFixedIpArgs

    IpAddress string
    SubnetId string
    IpAddress string
    SubnetId string
    ipAddress String
    subnetId String
    ipAddress string
    subnetId string
    ipAddress String
    subnetId String

    NetworkingRouterTimeouts, NetworkingRouterTimeoutsArgs

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

    NetworkingRouterVendorOptions, NetworkingRouterVendorOptionsArgs

    SetRouterGatewayAfterCreate bool
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.
    SetRouterGatewayAfterCreate bool
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.
    setRouterGatewayAfterCreate Boolean
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.
    setRouterGatewayAfterCreate boolean
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.
    set_router_gateway_after_create bool
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.
    setRouterGatewayAfterCreate Boolean
    optional boolean → Boolean to control whether the Router gateway is assigned during creation or updated after creation.

    Import

    Routers can be imported using the id, e.g.

    $ pulumi import vkcs:index/networkingRouter:NetworkingRouter router_1 014395cd-89fc-4c9b-96b7-13d1ee79dad2
    

    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