1. Packages
  2. Packages
  3. stackit
  4. API Docs
  5. NetworkAreaRoute
Viewing docs for stackit v0.0.5
published on Tuesday, Mar 31, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.NetworkAreaRoute

stackit logo
Viewing docs for stackit v0.0.5
published on Tuesday, Mar 31, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Network area route resource schema. Must have a region specified in the provider configuration.

    Example Usage

    resource "stackit_network_area_route" "example" {
  organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  destination = {
    type  = "cidrv4"
    value = "192.168.0.0/24"
  }
  next_hop = {
    type  = "ipv4"
    value = "192.168.0.0"
  }
  labels = {
    "key" = "value"
  }
}

# Only use the import statement, if you want to import an existing network area route
import {
  to = stackit_network_area_route.import-example
  id = "${var.organization_id},${var.network_area_id},${var.region},${var.network_area_route_id}"
}

    Migration of IaaS resources from versions <= v0.74.0

    The release of the STACKIT IaaS API v2 provides a lot of new features, but also includes some breaking changes (when coming from v1 of the STACKIT IaaS API) which must be somehow represented on Terraform side. The stackit.NetworkAreaRoute resource did undergo some changes. See the example below how to migrate your resources.

    Breaking change: Network area route resource (stackit_network_area_route)

    Configuration for <= v0.74.0

    resource "stackit_network_area_route" "example" {
  organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  prefix          = "192.168.0.0/24" # prefix field got removed for provider versions > v0.74.0, use the new destination field instead
  next_hop        = "192.168.0.0" # schema of the next_hop field changed, see below
}

    Configuration for > v0.74.0

    resource "stackit_network_area_route" "example" {
  organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  destination = { # the new 'destination' field replaces the old 'prefix' field
    type  = "cidrv4"
    value = "192.168.0.0/24" # migration: put the value of the old 'prefix' field here
  }
  next_hop = {
    type  = "ipv4"
    value = "192.168.0.0" # migration: put the value of the old 'next_hop' field here
  }
}

    Create NetworkAreaRoute Resource

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

    Constructor syntax

    new NetworkAreaRoute(name: string, args: NetworkAreaRouteArgs, opts?: CustomResourceOptions);
    @overload
def NetworkAreaRoute(resource_name: str,
                     args: NetworkAreaRouteArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def NetworkAreaRoute(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     destination: Optional[NetworkAreaRouteDestinationArgs] = None,
                     network_area_id: Optional[str] = None,
                     next_hop: Optional[NetworkAreaRouteNextHopArgs] = None,
                     organization_id: Optional[str] = None,
                     labels: Optional[Mapping[str, str]] = None,
                     region: Optional[str] = None)
    func NewNetworkAreaRoute(ctx *Context, name string, args NetworkAreaRouteArgs, opts ...ResourceOption) (*NetworkAreaRoute, error)
    public NetworkAreaRoute(string name, NetworkAreaRouteArgs args, CustomResourceOptions? opts = null)
    public NetworkAreaRoute(String name, NetworkAreaRouteArgs args)
public NetworkAreaRoute(String name, NetworkAreaRouteArgs args, CustomResourceOptions options)

    type: stackit:NetworkAreaRoute
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 NetworkAreaRouteArgs
    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 NetworkAreaRouteArgs
    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 NetworkAreaRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkAreaRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkAreaRouteArgs
    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 networkAreaRouteResource = new Stackit.NetworkAreaRoute("networkAreaRouteResource", new()
{
    Destination = new Stackit.Inputs.NetworkAreaRouteDestinationArgs
    {
        Type = "string",
        Value = "string",
    },
    NetworkAreaId = "string",
    NextHop = new Stackit.Inputs.NetworkAreaRouteNextHopArgs
    {
        Type = "string",
        Value = "string",
    },
    OrganizationId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Region = "string",
});

    example, err := stackit.NewNetworkAreaRoute(ctx, "networkAreaRouteResource", &stackit.NetworkAreaRouteArgs{
	Destination: &stackit.NetworkAreaRouteDestinationArgs{
		Type:  pulumi.String("string"),
		Value: pulumi.String("string"),
	},
	NetworkAreaId: pulumi.String("string"),
	NextHop: &stackit.NetworkAreaRouteNextHopArgs{
		Type:  pulumi.String("string"),
		Value: pulumi.String("string"),
	},
	OrganizationId: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Region: pulumi.String("string"),
})

    var networkAreaRouteResource = new NetworkAreaRoute("networkAreaRouteResource", NetworkAreaRouteArgs.builder()
    .destination(NetworkAreaRouteDestinationArgs.builder()
        .type("string")
        .value("string")
        .build())
    .networkAreaId("string")
    .nextHop(NetworkAreaRouteNextHopArgs.builder()
        .type("string")
        .value("string")
        .build())
    .organizationId("string")
    .labels(Map.of("string", "string"))
    .region("string")
    .build());

    network_area_route_resource = stackit.NetworkAreaRoute("networkAreaRouteResource",
    destination={
        "type": "string",
        "value": "string",
    },
    network_area_id="string",
    next_hop={
        "type": "string",
        "value": "string",
    },
    organization_id="string",
    labels={
        "string": "string",
    },
    region="string")

    const networkAreaRouteResource = new stackit.NetworkAreaRoute("networkAreaRouteResource", {
    destination: {
        type: "string",
        value: "string",
    },
    networkAreaId: "string",
    nextHop: {
        type: "string",
        value: "string",
    },
    organizationId: "string",
    labels: {
        string: "string",
    },
    region: "string",
});

    type: stackit:NetworkAreaRoute
properties:
    destination:
        type: string
        value: string
    labels:
        string: string
    networkAreaId: string
    nextHop:
        type: string
        value: string
    organizationId: string
    region: string

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

    Destination NetworkAreaRouteDestination
    Destination of the route.
    NetworkAreaId string
    The network area ID to which the network area route is associated.
    NextHop NetworkAreaRouteNextHop
    Next hop destination.
    OrganizationId string
    STACKIT organization ID to which the network area is associated.
    Labels Dictionary<string, string>
    Labels are key-value string pairs which can be attached to a resource container
    Region string
    The resource region. If not defined, the provider region is used.
    Destination NetworkAreaRouteDestinationArgs
    Destination of the route.
    NetworkAreaId string
    The network area ID to which the network area route is associated.
    NextHop NetworkAreaRouteNextHopArgs
    Next hop destination.
    OrganizationId string
    STACKIT organization ID to which the network area is associated.
    Labels map[string]string
    Labels are key-value string pairs which can be attached to a resource container
    Region string
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestination
    Destination of the route.
    networkAreaId String
    The network area ID to which the network area route is associated.
    nextHop NetworkAreaRouteNextHop
    Next hop destination.
    organizationId String
    STACKIT organization ID to which the network area is associated.
    labels Map<String,String>
    Labels are key-value string pairs which can be attached to a resource container
    region String
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestination
    Destination of the route.
    networkAreaId string
    The network area ID to which the network area route is associated.
    nextHop NetworkAreaRouteNextHop
    Next hop destination.
    organizationId string
    STACKIT organization ID to which the network area is associated.
    labels {[key: string]: string}
    Labels are key-value string pairs which can be attached to a resource container
    region string
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestinationArgs
    Destination of the route.
    network_area_id str
    The network area ID to which the network area route is associated.
    next_hop NetworkAreaRouteNextHopArgs
    Next hop destination.
    organization_id str
    STACKIT organization ID to which the network area is associated.
    labels Mapping[str, str]
    Labels are key-value string pairs which can be attached to a resource container
    region str
    The resource region. If not defined, the provider region is used.
    destination Property Map
    Destination of the route.
    networkAreaId String
    The network area ID to which the network area route is associated.
    nextHop Property Map
    Next hop destination.
    organizationId String
    STACKIT organization ID to which the network area is associated.
    labels Map<String>
    Labels are key-value string pairs which can be attached to a resource container
    region String
    The resource region. If not defined, the provider region is used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAreaRouteId string
    The network area route ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAreaRouteId string
    The network area route ID.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAreaRouteId String
    The network area route ID.
    id string
    The provider-assigned unique ID for this managed resource.
    networkAreaRouteId string
    The network area route ID.
    id str
    The provider-assigned unique ID for this managed resource.
    network_area_route_id str
    The network area route ID.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAreaRouteId String
    The network area route ID.

    Look up Existing NetworkAreaRoute Resource

    Get an existing NetworkAreaRoute 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?: NetworkAreaRouteState, opts?: CustomResourceOptions): NetworkAreaRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination: Optional[NetworkAreaRouteDestinationArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        network_area_id: Optional[str] = None,
        network_area_route_id: Optional[str] = None,
        next_hop: Optional[NetworkAreaRouteNextHopArgs] = None,
        organization_id: Optional[str] = None,
        region: Optional[str] = None) -> NetworkAreaRoute
    func GetNetworkAreaRoute(ctx *Context, name string, id IDInput, state *NetworkAreaRouteState, opts ...ResourceOption) (*NetworkAreaRoute, error)
    public static NetworkAreaRoute Get(string name, Input<string> id, NetworkAreaRouteState? state, CustomResourceOptions? opts = null)
    public static NetworkAreaRoute get(String name, Output<String> id, NetworkAreaRouteState state, CustomResourceOptions options)
    resources:  _:    type: stackit:NetworkAreaRoute    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:
    Destination NetworkAreaRouteDestination
    Destination of the route.
    Labels Dictionary<string, string>
    Labels are key-value string pairs which can be attached to a resource container
    NetworkAreaId string
    The network area ID to which the network area route is associated.
    NetworkAreaRouteId string
    The network area route ID.
    NextHop NetworkAreaRouteNextHop
    Next hop destination.
    OrganizationId string
    STACKIT organization ID to which the network area is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Destination NetworkAreaRouteDestinationArgs
    Destination of the route.
    Labels map[string]string
    Labels are key-value string pairs which can be attached to a resource container
    NetworkAreaId string
    The network area ID to which the network area route is associated.
    NetworkAreaRouteId string
    The network area route ID.
    NextHop NetworkAreaRouteNextHopArgs
    Next hop destination.
    OrganizationId string
    STACKIT organization ID to which the network area is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestination
    Destination of the route.
    labels Map<String,String>
    Labels are key-value string pairs which can be attached to a resource container
    networkAreaId String
    The network area ID to which the network area route is associated.
    networkAreaRouteId String
    The network area route ID.
    nextHop NetworkAreaRouteNextHop
    Next hop destination.
    organizationId String
    STACKIT organization ID to which the network area is associated.
    region String
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestination
    Destination of the route.
    labels {[key: string]: string}
    Labels are key-value string pairs which can be attached to a resource container
    networkAreaId string
    The network area ID to which the network area route is associated.
    networkAreaRouteId string
    The network area route ID.
    nextHop NetworkAreaRouteNextHop
    Next hop destination.
    organizationId string
    STACKIT organization ID to which the network area is associated.
    region string
    The resource region. If not defined, the provider region is used.
    destination NetworkAreaRouteDestinationArgs
    Destination of the route.
    labels Mapping[str, str]
    Labels are key-value string pairs which can be attached to a resource container
    network_area_id str
    The network area ID to which the network area route is associated.
    network_area_route_id str
    The network area route ID.
    next_hop NetworkAreaRouteNextHopArgs
    Next hop destination.
    organization_id str
    STACKIT organization ID to which the network area is associated.
    region str
    The resource region. If not defined, the provider region is used.
    destination Property Map
    Destination of the route.
    labels Map<String>
    Labels are key-value string pairs which can be attached to a resource container
    networkAreaId String
    The network area ID to which the network area route is associated.
    networkAreaRouteId String
    The network area route ID.
    nextHop Property Map
    Next hop destination.
    organizationId String
    STACKIT organization ID to which the network area is associated.
    region String
    The resource region. If not defined, the provider region is used.

    Supporting Types

    NetworkAreaRouteDestination, NetworkAreaRouteDestinationArgs

    Type string
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    Value string
    An CIDR string.
    Type string
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    Value string
    An CIDR string.
    type String
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    value String
    An CIDR string.
    type string
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    value string
    An CIDR string.
    type str
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    value str
    An CIDR string.
    type String
    CIDRV type. Possible values are: cidrv4, cidrv6. Only cidrv4 is supported currently.
    value String
    An CIDR string.

    NetworkAreaRouteNextHop, NetworkAreaRouteNextHopArgs

    Type string
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    Value string
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.
    Type string
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    Value string
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.
    type String
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    value String
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.
    type string
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    value string
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.
    type str
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    value str
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.
    type String
    Type of the next hop. Possible values are: blackhole, internet, ipv4, ipv6. Only ipv4 supported currently.
    value String
    Either IPv4 or IPv6 (not set for blackhole and internet). Only IPv4 supported currently.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.5
    published on Tuesday, Mar 31, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.