scaleway.network.getRoutes

Explore with Pulumi AI

Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse

Using getRoutes

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoutes(args: GetRoutesArgs, opts?: InvokeOptions): Promise<GetRoutesResult>
function getRoutesOutput(args: GetRoutesOutputArgs, opts?: InvokeOptions): Output<GetRoutesResult>

def get_routes(is_ipv6: Optional[bool] = None,
               nexthop_private_network_id: Optional[str] = None,
               nexthop_resource_id: Optional[str] = None,
               nexthop_resource_type: Optional[str] = None,
               region: Optional[str] = None,
               tags: Optional[Sequence[str]] = None,
               vpc_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetRoutesResult
def get_routes_output(is_ipv6: Optional[pulumi.Input[bool]] = None,
               nexthop_private_network_id: Optional[pulumi.Input[str]] = None,
               nexthop_resource_id: Optional[pulumi.Input[str]] = None,
               nexthop_resource_type: Optional[pulumi.Input[str]] = None,
               region: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               vpc_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetRoutesResult]

func GetRoutes(ctx *Context, args *GetRoutesArgs, opts ...InvokeOption) (*GetRoutesResult, error)
func GetRoutesOutput(ctx *Context, args *GetRoutesOutputArgs, opts ...InvokeOption) GetRoutesResultOutput

> Note: This function is named GetRoutes in the Go SDK.

public static class GetRoutes 
{
    public static Task<GetRoutesResult> InvokeAsync(GetRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutesResult> Invoke(GetRoutesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)
public static Output<GetRoutesResult> getRoutes(GetRoutesArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:network/getRoutes:getRoutes
  arguments:
    # arguments dictionary

The following arguments are supported:

IsIpv6 bool: Routes with an IPv6 destination will be listed.
NexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
NexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
NexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
Region string: region). The region in which the routes exist.
Tags List<string>: List of tags to filter for. routes with these exact tags are listed.
VpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

IsIpv6 bool: Routes with an IPv6 destination will be listed.
NexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
NexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
NexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
Region string: region). The region in which the routes exist.
Tags []string: List of tags to filter for. routes with these exact tags are listed.
VpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

isIpv6 Boolean: Routes with an IPv6 destination will be listed.
nexthopPrivateNetworkId String: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId String: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType String: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region String: region). The region in which the routes exist.
tags List<String>: List of tags to filter for. routes with these exact tags are listed.
vpcId String: The VPC ID to filter for. routes with a similar VPC ID are listed.

isIpv6 boolean: Routes with an IPv6 destination will be listed.
nexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region string: region). The region in which the routes exist.
tags string[]: List of tags to filter for. routes with these exact tags are listed.
vpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

is_ipv6 bool: Routes with an IPv6 destination will be listed.
nexthop_private_network_id str: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthop_resource_id str: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthop_resource_type str: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region str: region). The region in which the routes exist.
tags Sequence[str]: List of tags to filter for. routes with these exact tags are listed.
vpc_id str: The VPC ID to filter for. routes with a similar VPC ID are listed.

isIpv6 Boolean: Routes with an IPv6 destination will be listed.
nexthopPrivateNetworkId String: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId String: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType String: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region String: region). The region in which the routes exist.
tags List<String>: List of tags to filter for. routes with these exact tags are listed.
vpcId String: The VPC ID to filter for. routes with a similar VPC ID are listed.

getRoutes Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Region string
Routes List<Pulumiverse.Scaleway.Network.Outputs.GetRoutesRoute>: List of retrieved routes
IsIpv6 bool
NexthopPrivateNetworkId string
NexthopResourceId string
NexthopResourceType string
Tags List<string>
VpcId string

Id string: The provider-assigned unique ID for this managed resource.
Region string
Routes []GetRoutesRoute: List of retrieved routes
IsIpv6 bool
NexthopPrivateNetworkId string
NexthopResourceId string
NexthopResourceType string
Tags []string
VpcId string

id String: The provider-assigned unique ID for this managed resource.
region String
routes List<GetRoutesRoute>: List of retrieved routes
isIpv6 Boolean
nexthopPrivateNetworkId String
nexthopResourceId String
nexthopResourceType String
tags List<String>
vpcId String

id string: The provider-assigned unique ID for this managed resource.
region string
routes GetRoutesRoute[]: List of retrieved routes
isIpv6 boolean
nexthopPrivateNetworkId string
nexthopResourceId string
nexthopResourceType string
tags string[]
vpcId string

id str: The provider-assigned unique ID for this managed resource.
region str
routes Sequence[GetRoutesRoute]: List of retrieved routes
is_ipv6 bool
nexthop_private_network_id str
nexthop_resource_id str
nexthop_resource_type str
tags Sequence[str]
vpc_id str

id String: The provider-assigned unique ID for this managed resource.
region String
routes List<Property Map>: List of retrieved routes
isIpv6 Boolean
nexthopPrivateNetworkId String
nexthopResourceId String
nexthopResourceType String
tags List<String>
vpcId String

Supporting Types

GetRoutesRoute

CreatedAt string: The date on which the route was created (RFC 3339 format).
Description string: The description of the route.
Destination string: The destination IP or IP range of the route.
Id string: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
NexthopIp string: The IP of the route's next hop.
NexthopName string: The name of the route's next hop.
NexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
NexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
NexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
Region string: region). The region in which the routes exist.
Tags List<string>: List of tags to filter for. routes with these exact tags are listed.
VpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

CreatedAt string: The date on which the route was created (RFC 3339 format).
Description string: The description of the route.
Destination string: The destination IP or IP range of the route.
Id string: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
NexthopIp string: The IP of the route's next hop.
NexthopName string: The name of the route's next hop.
NexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
NexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
NexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
Region string: region). The region in which the routes exist.
Tags []string: List of tags to filter for. routes with these exact tags are listed.
VpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

createdAt String: The date on which the route was created (RFC 3339 format).
description String: The description of the route.
destination String: The destination IP or IP range of the route.
id String: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
nexthopIp String: The IP of the route's next hop.
nexthopName String: The name of the route's next hop.
nexthopPrivateNetworkId String: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId String: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType String: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region String: region). The region in which the routes exist.
tags List<String>: List of tags to filter for. routes with these exact tags are listed.
vpcId String: The VPC ID to filter for. routes with a similar VPC ID are listed.

createdAt string: The date on which the route was created (RFC 3339 format).
description string: The description of the route.
destination string: The destination IP or IP range of the route.
id string: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
nexthopIp string: The IP of the route's next hop.
nexthopName string: The name of the route's next hop.
nexthopPrivateNetworkId string: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId string: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType string: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region string: region). The region in which the routes exist.
tags string[]: List of tags to filter for. routes with these exact tags are listed.
vpcId string: The VPC ID to filter for. routes with a similar VPC ID are listed.

created_at str: The date on which the route was created (RFC 3339 format).
description str: The description of the route.
destination str: The destination IP or IP range of the route.
id str: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
nexthop_ip str: The IP of the route's next hop.
nexthop_name str: The name of the route's next hop.
nexthop_private_network_id str: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthop_resource_id str: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthop_resource_type str: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region str: region). The region in which the routes exist.
tags Sequence[str]: List of tags to filter for. routes with these exact tags are listed.
vpc_id str: The VPC ID to filter for. routes with a similar VPC ID are listed.

createdAt String: The date on which the route was created (RFC 3339 format).
description String: The description of the route.
destination String: The destination IP or IP range of the route.
id String: The ID of the route.
Important: route IDs are regional, which means they are of the form {region}/{id}, e.g. `fr-par/11111111-1111-1111-1111-111111111111
nexthopIp String: The IP of the route's next hop.
nexthopName String: The name of the route's next hop.
nexthopPrivateNetworkId String: The next hop private network ID to filter for. routes with a similar next hop private network ID are listed.
nexthopResourceId String: The next hop resource ID to filter for. routes with a similar next hop resource ID are listed.
nexthopResourceType String: The next hop resource type to filter for. routes with a similar next hop resource type are listed.
region String: region). The region in which the routes exist.
tags List<String>: List of tags to filter for. routes with these exact tags are listed.
vpcId String: The VPC ID to filter for. routes with a similar VPC ID are listed.

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.network.getRoutes

On this page

On this page

Using getRoutes

getRoutes Result

Supporting Types

GetRoutesRoute

Package Details

On this page

On this page