ibm 1.77.1, Apr 14 25

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.IsVpcRoutingTableRoute

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

{}

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const exampleIsVpc = new ibm.IsVpc("exampleIsVpc", {});
const exampleIsVpcRoutingTable = new ibm.IsVpcRoutingTable("exampleIsVpcRoutingTable", {
    vpc: exampleIsVpc.isVpcId,
    advertiseRoutesTos: [
        "direct_link",
        "transit_gateway",
    ],
    routeDirectLinkIngress: true,
    routeTransitGatewayIngress: false,
    routeVpcZoneIngress: false,
});
const exampleIsVpcRoutingTableRoute = new ibm.IsVpcRoutingTableRoute("exampleIsVpcRoutingTableRoute", {
    vpc: exampleIsVpc.isVpcId,
    routingTable: exampleIsVpcRoutingTable.routingTable,
    zone: "us-south-1",
    destination: "192.168.4.0/24",
    action: "deliver",
    advertise: true,
    nextHop: ibm_is_vpn_gateway_connection.example.gateway_connection,
});
// Example value "10.0.0.4"

import pulumi
import pulumi_ibm as ibm

example_is_vpc = ibm.IsVpc("exampleIsVpc")
example_is_vpc_routing_table = ibm.IsVpcRoutingTable("exampleIsVpcRoutingTable",
    vpc=example_is_vpc.is_vpc_id,
    advertise_routes_tos=[
        "direct_link",
        "transit_gateway",
    ],
    route_direct_link_ingress=True,
    route_transit_gateway_ingress=False,
    route_vpc_zone_ingress=False)
example_is_vpc_routing_table_route = ibm.IsVpcRoutingTableRoute("exampleIsVpcRoutingTableRoute",
    vpc=example_is_vpc.is_vpc_id,
    routing_table=example_is_vpc_routing_table.routing_table,
    zone="us-south-1",
    destination="192.168.4.0/24",
    action="deliver",
    advertise=True,
    next_hop=ibm_is_vpn_gateway_connection["example"]["gateway_connection"])
# Example value "10.0.0.4"

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleIsVpc, err := ibm.NewIsVpc(ctx, "exampleIsVpc", nil)
		if err != nil {
			return err
		}
		exampleIsVpcRoutingTable, err := ibm.NewIsVpcRoutingTable(ctx, "exampleIsVpcRoutingTable", &ibm.IsVpcRoutingTableArgs{
			Vpc: exampleIsVpc.IsVpcId,
			AdvertiseRoutesTos: pulumi.StringArray{
				pulumi.String("direct_link"),
				pulumi.String("transit_gateway"),
			},
			RouteDirectLinkIngress:     pulumi.Bool(true),
			RouteTransitGatewayIngress: pulumi.Bool(false),
			RouteVpcZoneIngress:        pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVpcRoutingTableRoute(ctx, "exampleIsVpcRoutingTableRoute", &ibm.IsVpcRoutingTableRouteArgs{
			Vpc:          exampleIsVpc.IsVpcId,
			RoutingTable: exampleIsVpcRoutingTable.RoutingTable,
			Zone:         pulumi.String("us-south-1"),
			Destination:  pulumi.String("192.168.4.0/24"),
			Action:       pulumi.String("deliver"),
			Advertise:    pulumi.Bool(true),
			NextHop:      pulumi.Any(ibm_is_vpn_gateway_connection.Example.Gateway_connection),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var exampleIsVpc = new Ibm.IsVpc("exampleIsVpc");

    var exampleIsVpcRoutingTable = new Ibm.IsVpcRoutingTable("exampleIsVpcRoutingTable", new()
    {
        Vpc = exampleIsVpc.IsVpcId,
        AdvertiseRoutesTos = new[]
        {
            "direct_link",
            "transit_gateway",
        },
        RouteDirectLinkIngress = true,
        RouteTransitGatewayIngress = false,
        RouteVpcZoneIngress = false,
    });

    var exampleIsVpcRoutingTableRoute = new Ibm.IsVpcRoutingTableRoute("exampleIsVpcRoutingTableRoute", new()
    {
        Vpc = exampleIsVpc.IsVpcId,
        RoutingTable = exampleIsVpcRoutingTable.RoutingTable,
        Zone = "us-south-1",
        Destination = "192.168.4.0/24",
        Action = "deliver",
        Advertise = true,
        NextHop = ibm_is_vpn_gateway_connection.Example.Gateway_connection,
    });

    // Example value "10.0.0.4"
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpc;
import com.pulumi.ibm.IsVpcRoutingTable;
import com.pulumi.ibm.IsVpcRoutingTableArgs;
import com.pulumi.ibm.IsVpcRoutingTableRoute;
import com.pulumi.ibm.IsVpcRoutingTableRouteArgs;
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 exampleIsVpc = new IsVpc("exampleIsVpc");

        var exampleIsVpcRoutingTable = new IsVpcRoutingTable("exampleIsVpcRoutingTable", IsVpcRoutingTableArgs.builder()
            .vpc(exampleIsVpc.isVpcId())
            .advertiseRoutesTos(            
                "direct_link",
                "transit_gateway")
            .routeDirectLinkIngress(true)
            .routeTransitGatewayIngress(false)
            .routeVpcZoneIngress(false)
            .build());

        var exampleIsVpcRoutingTableRoute = new IsVpcRoutingTableRoute("exampleIsVpcRoutingTableRoute", IsVpcRoutingTableRouteArgs.builder()
            .vpc(exampleIsVpc.isVpcId())
            .routingTable(exampleIsVpcRoutingTable.routingTable())
            .zone("us-south-1")
            .destination("192.168.4.0/24")
            .action("deliver")
            .advertise(true)
            .nextHop(ibm_is_vpn_gateway_connection.example().gateway_connection())
            .build());

        // Example value "10.0.0.4"
    }
}

resources:
  exampleIsVpc:
    type: ibm:IsVpc
  exampleIsVpcRoutingTable:
    type: ibm:IsVpcRoutingTable
    properties:
      vpc: ${exampleIsVpc.isVpcId}
      advertiseRoutesTos:
        - direct_link
        - transit_gateway
      routeDirectLinkIngress: true
      routeTransitGatewayIngress: false
      routeVpcZoneIngress: false
  exampleIsVpcRoutingTableRoute:
    type: ibm:IsVpcRoutingTableRoute
    properties:
      vpc: ${exampleIsVpc.isVpcId}
      routingTable: ${exampleIsVpcRoutingTable.routingTable}
      zone: us-south-1
      destination: 192.168.4.0/24
      action: deliver
      advertise: true
      nextHop: ${ibm_is_vpn_gateway_connection.example.gateway_connection}

Route priority support:

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsVpcRoutingTableRoute("example", {
    vpc: ibm_is_vpc.example.id,
    routingTable: ibm_is_vpc_routing_table.example.routing_table,
    zone: "us-south-1",
    destination: "192.168.4.0/24",
    action: "deliver",
    nextHop: ibm_is_vpn_gateway_connection.example.gateway_connection,
    priority: 1,
});

import pulumi
import pulumi_ibm as ibm

example = ibm.IsVpcRoutingTableRoute("example",
    vpc=ibm_is_vpc["example"]["id"],
    routing_table=ibm_is_vpc_routing_table["example"]["routing_table"],
    zone="us-south-1",
    destination="192.168.4.0/24",
    action="deliver",
    next_hop=ibm_is_vpn_gateway_connection["example"]["gateway_connection"],
    priority=1)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVpcRoutingTableRoute(ctx, "example", &ibm.IsVpcRoutingTableRouteArgs{
			Vpc:          pulumi.Any(ibm_is_vpc.Example.Id),
			RoutingTable: pulumi.Any(ibm_is_vpc_routing_table.Example.Routing_table),
			Zone:         pulumi.String("us-south-1"),
			Destination:  pulumi.String("192.168.4.0/24"),
			Action:       pulumi.String("deliver"),
			NextHop:      pulumi.Any(ibm_is_vpn_gateway_connection.Example.Gateway_connection),
			Priority:     pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVpcRoutingTableRoute("example", new()
    {
        Vpc = ibm_is_vpc.Example.Id,
        RoutingTable = ibm_is_vpc_routing_table.Example.Routing_table,
        Zone = "us-south-1",
        Destination = "192.168.4.0/24",
        Action = "deliver",
        NextHop = ibm_is_vpn_gateway_connection.Example.Gateway_connection,
        Priority = 1,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpcRoutingTableRoute;
import com.pulumi.ibm.IsVpcRoutingTableRouteArgs;
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 example = new IsVpcRoutingTableRoute("example", IsVpcRoutingTableRouteArgs.builder()
            .vpc(ibm_is_vpc.example().id())
            .routingTable(ibm_is_vpc_routing_table.example().routing_table())
            .zone("us-south-1")
            .destination("192.168.4.0/24")
            .action("deliver")
            .nextHop(ibm_is_vpn_gateway_connection.example().gateway_connection())
            .priority(1)
            .build());

    }
}

resources:
  example:
    type: ibm:IsVpcRoutingTableRoute
    properties:
      vpc: ${ibm_is_vpc.example.id}
      routingTable: ${ibm_is_vpc_routing_table.example.routing_table}
      zone: us-south-1
      destination: 192.168.4.0/24
      action: deliver
      nextHop: ${ibm_is_vpn_gateway_connection.example.gateway_connection}
      # Example value "10.0.0.4"
      priority: 1

Create IsVpcRoutingTableRoute Resource

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

new IsVpcRoutingTableRoute(name: string, args: IsVpcRoutingTableRouteArgs, opts?: CustomResourceOptions);

@overload
def IsVpcRoutingTableRoute(resource_name: str,
                           args: IsVpcRoutingTableRouteArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def IsVpcRoutingTableRoute(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           destination: Optional[str] = None,
                           next_hop: Optional[str] = None,
                           routing_table: Optional[str] = None,
                           vpc: Optional[str] = None,
                           zone: Optional[str] = None,
                           action: Optional[str] = None,
                           advertise: Optional[bool] = None,
                           is_vpc_routing_table_route_id: Optional[str] = None,
                           name: Optional[str] = None,
                           priority: Optional[float] = None,
                           timeouts: Optional[IsVpcRoutingTableRouteTimeoutsArgs] = None)

func NewIsVpcRoutingTableRoute(ctx *Context, name string, args IsVpcRoutingTableRouteArgs, opts ...ResourceOption) (*IsVpcRoutingTableRoute, error)

public IsVpcRoutingTableRoute(string name, IsVpcRoutingTableRouteArgs args, CustomResourceOptions? opts = null)

public IsVpcRoutingTableRoute(String name, IsVpcRoutingTableRouteArgs args)
public IsVpcRoutingTableRoute(String name, IsVpcRoutingTableRouteArgs args, CustomResourceOptions options)

type: ibm:IsVpcRoutingTableRoute
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 IsVpcRoutingTableRouteArgs: 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 IsVpcRoutingTableRouteArgs: 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 IsVpcRoutingTableRouteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IsVpcRoutingTableRouteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IsVpcRoutingTableRouteArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var isVpcRoutingTableRouteResource = new Ibm.IsVpcRoutingTableRoute("isVpcRoutingTableRouteResource", new()
{
    Destination = "string",
    NextHop = "string",
    RoutingTable = "string",
    Vpc = "string",
    Zone = "string",
    Action = "string",
    Advertise = false,
    IsVpcRoutingTableRouteId = "string",
    Name = "string",
    Priority = 0,
    Timeouts = new Ibm.Inputs.IsVpcRoutingTableRouteTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

example, err := ibm.NewIsVpcRoutingTableRoute(ctx, "isVpcRoutingTableRouteResource", &ibm.IsVpcRoutingTableRouteArgs{
Destination: pulumi.String("string"),
NextHop: pulumi.String("string"),
RoutingTable: pulumi.String("string"),
Vpc: pulumi.String("string"),
Zone: pulumi.String("string"),
Action: pulumi.String("string"),
Advertise: pulumi.Bool(false),
IsVpcRoutingTableRouteId: pulumi.String("string"),
Name: pulumi.String("string"),
Priority: pulumi.Float64(0),
Timeouts: &.IsVpcRoutingTableRouteTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})

var isVpcRoutingTableRouteResource = new IsVpcRoutingTableRoute("isVpcRoutingTableRouteResource", IsVpcRoutingTableRouteArgs.builder()
    .destination("string")
    .nextHop("string")
    .routingTable("string")
    .vpc("string")
    .zone("string")
    .action("string")
    .advertise(false)
    .isVpcRoutingTableRouteId("string")
    .name("string")
    .priority(0)
    .timeouts(IsVpcRoutingTableRouteTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

is_vpc_routing_table_route_resource = ibm.IsVpcRoutingTableRoute("isVpcRoutingTableRouteResource",
    destination="string",
    next_hop="string",
    routing_table="string",
    vpc="string",
    zone="string",
    action="string",
    advertise=False,
    is_vpc_routing_table_route_id="string",
    name="string",
    priority=0,
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

const isVpcRoutingTableRouteResource = new ibm.IsVpcRoutingTableRoute("isVpcRoutingTableRouteResource", {
    destination: "string",
    nextHop: "string",
    routingTable: "string",
    vpc: "string",
    zone: "string",
    action: "string",
    advertise: false,
    isVpcRoutingTableRouteId: "string",
    name: "string",
    priority: 0,
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

type: ibm:IsVpcRoutingTableRoute
properties:
    action: string
    advertise: false
    destination: string
    isVpcRoutingTableRouteId: string
    name: string
    nextHop: string
    priority: 0
    routingTable: string
    timeouts:
        create: string
        delete: string
        update: string
    vpc: string
    zone: string

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

Destination string: The destination of the route.
NextHop string: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
RoutingTable string: The routing table ID.
Vpc string: The VPC ID.
Zone string: Name of the zone.
Action string: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
Advertise bool: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
IsVpcRoutingTableRouteId string: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
Name string: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
Priority double: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
Timeouts IsVpcRoutingTableRouteTimeouts

Destination string: The destination of the route.
NextHop string: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
RoutingTable string: The routing table ID.
Vpc string: The VPC ID.
Zone string: Name of the zone.
Action string: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
Advertise bool: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
IsVpcRoutingTableRouteId string: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
Name string: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
Priority float64: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
Timeouts IsVpcRoutingTableRouteTimeoutsArgs

destination String: The destination of the route.
nextHop String: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
routingTable String: The routing table ID.
vpc String: The VPC ID.
zone String: Name of the zone.
action String: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
advertise Boolean: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
isVpcRoutingTableRouteId String: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
name String: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
priority Double: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
timeouts IsVpcRoutingTableRouteTimeouts

destination string: The destination of the route.
nextHop string: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
routingTable string: The routing table ID.
vpc string: The VPC ID.
zone string: Name of the zone.
action string: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
advertise boolean: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
isVpcRoutingTableRouteId string: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
name string: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
priority number: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
timeouts IsVpcRoutingTableRouteTimeouts

destination str: The destination of the route.
next_hop str: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
routing_table str: The routing table ID.
vpc str: The VPC ID.
zone str: Name of the zone.
action str: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
advertise bool: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
is_vpc_routing_table_route_id str: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
name str: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
priority float: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
timeouts IsVpcRoutingTableRouteTimeoutsArgs

destination String: The destination of the route.
nextHop String: The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.
routingTable String: The routing table ID.
vpc String: The VPC ID.
zone String: Name of the zone.
action String: The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.
advertise Boolean: Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.
isVpcRoutingTableRouteId String: (String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.
name String: The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.
priority Number: The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.
timeouts Property Map

Outputs

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

CreatedAt string

Routing table route Created At

Creators List<IsVpcRoutingTableRouteCreator>

(Optional, List) If present, the resource that created the route. Routes with this property present cannot bedirectly deleted. All routes with an origin of learned or service will have thisproperty set, and future origin values may also have this property set.

Href string

(String) The routing table URL.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleState string

(String) The lifecycle state of the route.

Origin string

(Optional, String) The origin of this route:- service: route was directly created by a service- user: route was directly created by a userThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

Constraints: Allowable values are: learned, service, user.

RouteId string

The routing table route identifier.

CreatedAt string

Routing table route Created At

Creators []IsVpcRoutingTableRouteCreator

Href string

(String) The routing table URL.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleState string

(String) The lifecycle state of the route.

Origin string

Constraints: Allowable values are: learned, service, user.

RouteId string

The routing table route identifier.

createdAt String

Routing table route Created At

creators List<IsVpcRoutingTableRouteCreator>

href String

(String) The routing table URL.

id String

The provider-assigned unique ID for this managed resource.

lifecycleState String

(String) The lifecycle state of the route.

origin String

Constraints: Allowable values are: learned, service, user.

routeId String

The routing table route identifier.

createdAt string

Routing table route Created At

creators IsVpcRoutingTableRouteCreator[]

href string

(String) The routing table URL.

id string

The provider-assigned unique ID for this managed resource.

lifecycleState string

(String) The lifecycle state of the route.

origin string

Constraints: Allowable values are: learned, service, user.

routeId string

The routing table route identifier.

created_at str

Routing table route Created At

creators Sequence[IsVpcRoutingTableRouteCreator]

href str

(String) The routing table URL.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_state str

(String) The lifecycle state of the route.

origin str

Constraints: Allowable values are: learned, service, user.

route_id str

The routing table route identifier.

createdAt String

Routing table route Created At

creators List<Property Map>

href String

(String) The routing table URL.

id String

The provider-assigned unique ID for this managed resource.

lifecycleState String

(String) The lifecycle state of the route.

origin String

Constraints: Allowable values are: learned, service, user.

routeId String

The routing table route identifier.

Look up Existing IsVpcRoutingTableRoute Resource

Get an existing IsVpcRoutingTableRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: IsVpcRoutingTableRouteState, opts?: CustomResourceOptions): IsVpcRoutingTableRoute

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        advertise: Optional[bool] = None,
        created_at: Optional[str] = None,
        creators: Optional[Sequence[IsVpcRoutingTableRouteCreatorArgs]] = None,
        destination: Optional[str] = None,
        href: Optional[str] = None,
        is_vpc_routing_table_route_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        next_hop: Optional[str] = None,
        origin: Optional[str] = None,
        priority: Optional[float] = None,
        route_id: Optional[str] = None,
        routing_table: Optional[str] = None,
        timeouts: Optional[IsVpcRoutingTableRouteTimeoutsArgs] = None,
        vpc: Optional[str] = None,
        zone: Optional[str] = None) -> IsVpcRoutingTableRoute

func GetIsVpcRoutingTableRoute(ctx *Context, name string, id IDInput, state *IsVpcRoutingTableRouteState, opts ...ResourceOption) (*IsVpcRoutingTableRoute, error)

public static IsVpcRoutingTableRoute Get(string name, Input<string> id, IsVpcRoutingTableRouteState? state, CustomResourceOptions? opts = null)

public static IsVpcRoutingTableRoute get(String name, Output<String> id, IsVpcRoutingTableRouteState state, CustomResourceOptions options)

resources:  _:    type: ibm:IsVpcRoutingTableRoute    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:

Action string

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

Advertise bool

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

CreatedAt string

Routing table route Created At

Creators List<IsVpcRoutingTableRouteCreator>

Destination string

The destination of the route.

Href string

(String) The routing table URL.

IsVpcRoutingTableRouteId string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

LifecycleState string

(String) The lifecycle state of the route.

Name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

NextHop string

The next hop of the route. It accepts IP address or a VPN gateway connection ID (ibm.IsVpnGatewayConnection) of a VPN Gateway (ibm.IsVpnGateway) with the mode = "route" argument and in the same VPC as the route table for this route for an egress route. For action other than deliver, you must specify 0.0.0.0.

Origin string

Constraints: Allowable values are: learned, service, user.

Priority double

The route's priority. Smaller values have higher priority. If a routing table contains routes with the same destination, the route with the highest priority (smallest value) is selected. For Example (2), supports values from 0 to 4. Default is 2.

RouteId string

The routing table route identifier.

RoutingTable string

The routing table ID.

Timeouts IsVpcRoutingTableRouteTimeouts

Vpc string

The VPC ID.

Zone string

Name of the zone.

Action string

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

Advertise bool

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

CreatedAt string

Routing table route Created At

Creators []IsVpcRoutingTableRouteCreatorArgs

Destination string

The destination of the route.

Href string

(String) The routing table URL.

IsVpcRoutingTableRouteId string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

LifecycleState string

(String) The lifecycle state of the route.

Name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

NextHop string

Origin string

Constraints: Allowable values are: learned, service, user.

Priority float64

RouteId string

The routing table route identifier.

RoutingTable string

The routing table ID.

Timeouts IsVpcRoutingTableRouteTimeoutsArgs

Vpc string

The VPC ID.

Zone string

Name of the zone.

action String

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

advertise Boolean

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

createdAt String

Routing table route Created At

creators List<IsVpcRoutingTableRouteCreator>

destination String

The destination of the route.

href String

(String) The routing table URL.

isVpcRoutingTableRouteId String

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

lifecycleState String

(String) The lifecycle state of the route.

name String

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

nextHop String

origin String

Constraints: Allowable values are: learned, service, user.

priority Double

routeId String

The routing table route identifier.

routingTable String

The routing table ID.

timeouts IsVpcRoutingTableRouteTimeouts

vpc String

The VPC ID.

zone String

Name of the zone.

action string

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

advertise boolean

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

createdAt string

Routing table route Created At

creators IsVpcRoutingTableRouteCreator[]

destination string

The destination of the route.

href string

(String) The routing table URL.

isVpcRoutingTableRouteId string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

lifecycleState string

(String) The lifecycle state of the route.

name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

nextHop string

origin string

Constraints: Allowable values are: learned, service, user.

priority number

routeId string

The routing table route identifier.

routingTable string

The routing table ID.

timeouts IsVpcRoutingTableRouteTimeouts

vpc string

The VPC ID.

zone string

Name of the zone.

action str

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

advertise bool

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

created_at str

Routing table route Created At

creators Sequence[IsVpcRoutingTableRouteCreatorArgs]

destination str

The destination of the route.

href str

(String) The routing table URL.

is_vpc_routing_table_route_id str

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

lifecycle_state str

(String) The lifecycle state of the route.

name str

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

next_hop str

origin str

Constraints: Allowable values are: learned, service, user.

priority float

route_id str

The routing table route identifier.

routing_table str

The routing table ID.

timeouts IsVpcRoutingTableRouteTimeoutsArgs

vpc str

The VPC ID.

zone str

Name of the zone.

action String

The action to perform with a packet matching the route delegate, delegate_vpc, deliver, drop.

advertise Boolean

Indicates whether this route will be advertised to the ingress sources specified by the advertise_routes_to routing table's property.

createdAt String

Routing table route Created At

creators List<Property Map>

destination String

The destination of the route.

href String

(String) The routing table URL.

isVpcRoutingTableRouteId String

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

lifecycleState String

(String) The lifecycle state of the route.

name String

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

nextHop String

origin String

Constraints: Allowable values are: learned, service, user.

priority Number

routeId String

The routing table route identifier.

routingTable String

The routing table ID.

timeouts Property Map

vpc String

The VPC ID.

zone String

Name of the zone.

Supporting Types

IsVpcRoutingTableRouteCreator
, IsVpcRoutingTableRouteCreatorArgs

Crn string

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

Deleteds List<IsVpcRoutingTableRouteCreatorDeleted>

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

Href string

(String) The routing table URL.

Id string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

Name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

ResourceType string

(String) The resource type.

Crn string

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

Deleteds []IsVpcRoutingTableRouteCreatorDeleted

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

Href string

(String) The routing table URL.

Id string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

Name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

ResourceType string

(String) The resource type.

crn String

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

deleteds List<IsVpcRoutingTableRouteCreatorDeleted>

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

href String

(String) The routing table URL.

id String

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

name String

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

resourceType String

(String) The resource type.

crn string

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

deleteds IsVpcRoutingTableRouteCreatorDeleted[]

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

href string

(String) The routing table URL.

id string

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

name string

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

resourceType string

(String) The resource type.

crn str

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

deleteds Sequence[IsVpcRoutingTableRouteCreatorDeleted]

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

href str

(String) The routing table URL.

id str

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

name str

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

resource_type str

(String) The resource type.

crn String

(Optional, String) The VPN gateway's CRN.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters.

deleteds List<Property Map>

(Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:

href String

(String) The routing table URL.

id String

(String) The routing table ID. The ID is composed of <vpc_route_table_id>/<vpc_route_table_route_id>.

name String

The user-defined name of the route. If unspecified, the name will be a hyphenated list of randomly selected words. You need to provide unique name within the VPC routing table the route resides in.

resourceType String

(String) The resource type.

IsVpcRoutingTableRouteCreatorDeleted
, IsVpcRoutingTableRouteCreatorDeletedArgs

MoreInfo string

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

MoreInfo string

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

moreInfo String

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

moreInfo string

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

more_info str

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

moreInfo String

(Required, String) Link to documentation about deleted resources.

Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.

IsVpcRoutingTableRouteTimeouts
, IsVpcRoutingTableRouteTimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Import

The ibm_is_vpc_routing_table_route resource can be imported by using VPC ID, VPC Route table ID, and VPC Route table Route ID.

Example

$ pulumi import ibm:index/isVpcRoutingTableRoute:IsVpcRoutingTableRoute example 56738c92-4631-4eb5-8938-8af90000006ea4/4993-a0fd-cabab477c4d1-8af911111a4/fc2667e0-9e6f-4993-a0fd-cabab55557c4d1

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

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.IsVpcRoutingTableRoute

On this page

On this page

Example Usage

Create IsVpcRoutingTableRoute Resource

Constructor syntax

Parameters

Constructor example

IsVpcRoutingTableRoute Resource Properties

Inputs

Outputs

Look up Existing IsVpcRoutingTableRoute Resource

Supporting Types

IsVpcRoutingTableRouteCreator
, IsVpcRoutingTableRouteCreatorArgs

IsVpcRoutingTableRouteCreatorDeleted
, IsVpcRoutingTableRouteCreatorDeletedArgs

IsVpcRoutingTableRouteTimeouts
, IsVpcRoutingTableRouteTimeoutsArgs

Import

Package Details

On this page

On this page

ibm.IsVpcRoutingTableRoute

On this page

On this page

Example Usage

Create IsVpcRoutingTableRoute Resource

Constructor syntax

Parameters

Constructor example

IsVpcRoutingTableRoute Resource Properties

Inputs

Outputs

Look up Existing IsVpcRoutingTableRoute Resource

Supporting Types

IsVpcRoutingTableRouteCreator, IsVpcRoutingTableRouteCreatorArgs

IsVpcRoutingTableRouteCreatorDeleted, IsVpcRoutingTableRouteCreatorDeletedArgs

IsVpcRoutingTableRouteTimeouts, IsVpcRoutingTableRouteTimeoutsArgs

Import

Package Details

On this page

On this page

IsVpcRoutingTableRouteCreator
, IsVpcRoutingTableRouteCreatorArgs

IsVpcRoutingTableRouteCreatorDeleted
, IsVpcRoutingTableRouteCreatorDeletedArgs

IsVpcRoutingTableRouteTimeouts
, IsVpcRoutingTableRouteTimeoutsArgs