getLink

Scaleway v1.48.0, Apr 29 26

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Get link info by ID
const myLink = scaleway.interlink.getLink({
    linkId: "11111111-1111-1111-1111-111111111111",
});

import pulumi
import pulumi_scaleway as scaleway

# Get link info by ID
my_link = scaleway.interlink.get_link(link_id="11111111-1111-1111-1111-111111111111")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/interlink"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get link info by ID
		_, err := interlink.LookupLink(ctx, &interlink.LookupLinkArgs{
			LinkId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get link info by ID
    var myLink = Scaleway.Interlink.GetLink.Invoke(new()
    {
        LinkId = "11111111-1111-1111-1111-111111111111",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.interlink.InterlinkFunctions;
import com.pulumi.scaleway.interlink.inputs.GetLinkArgs;
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) {
        // Get link info by ID
        final var myLink = InterlinkFunctions.getLink(GetLinkArgs.builder()
            .linkId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

variables:
  # Get link info by ID
  myLink:
    fn::invoke:
      function: scaleway:interlink:getLink
      arguments:
        linkId: 11111111-1111-1111-1111-111111111111

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Get link info by name
const myLink = scaleway.interlink.getLink({
    name: "my-link",
});

import pulumi
import pulumi_scaleway as scaleway

# Get link info by name
my_link = scaleway.interlink.get_link(name="my-link")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/interlink"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get link info by name
		_, err := interlink.LookupLink(ctx, &interlink.LookupLinkArgs{
			Name: pulumi.StringRef("my-link"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get link info by name
    var myLink = Scaleway.Interlink.GetLink.Invoke(new()
    {
        Name = "my-link",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.interlink.InterlinkFunctions;
import com.pulumi.scaleway.interlink.inputs.GetLinkArgs;
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) {
        // Get link info by name
        final var myLink = InterlinkFunctions.getLink(GetLinkArgs.builder()
            .name("my-link")
            .build());

    }
}

variables:
  # Get link info by name
  myLink:
    fn::invoke:
      function: scaleway:interlink:getLink
      arguments:
        name: my-link

Using getLink

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 getLink(args: GetLinkArgs, opts?: InvokeOptions): Promise<GetLinkResult>
function getLinkOutput(args: GetLinkOutputArgs, opts?: InvokeOptions): Output<GetLinkResult>

def get_link(link_id: Optional[str] = None,
             name: Optional[str] = None,
             project_id: Optional[str] = None,
             region: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetLinkResult
def get_link_output(link_id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             project_id: Optional[pulumi.Input[str]] = None,
             region: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetLinkResult]

func LookupLink(ctx *Context, args *LookupLinkArgs, opts ...InvokeOption) (*LookupLinkResult, error)
func LookupLinkOutput(ctx *Context, args *LookupLinkOutputArgs, opts ...InvokeOption) LookupLinkResultOutput

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

public static class GetLink 
{
    public static Task<GetLinkResult> InvokeAsync(GetLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetLinkResult> Invoke(GetLinkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)
public static Output<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:interlink/getLink:getLink
  arguments:
    # arguments dictionary

The following arguments are supported:

LinkId string: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
Name string: Name of the link. Conflicts with linkId.
ProjectId string: Project ID.
Region string: region) The region in which the link exists.

LinkId string: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
Name string: Name of the link. Conflicts with linkId.
ProjectId string: Project ID.
Region string: region) The region in which the link exists.

linkId String: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
name String: Name of the link. Conflicts with linkId.
projectId String: Project ID.
region String: region) The region in which the link exists.

linkId string: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
name string: Name of the link. Conflicts with linkId.
projectId string: Project ID.
region string: region) The region in which the link exists.

link_id str: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
name str: Name of the link. Conflicts with linkId.
project_id str: Project ID.
region str: region) The region in which the link exists.

linkId String: Unique identifier of the link. Conflicts with name.
Note You must specify at least one: name and/or linkId.
name String: Name of the link. Conflicts with linkId.
projectId String: Project ID.
region String: region) The region in which the link exists.

getLink Result

The following output properties are available:

BandwidthMbps int: Rate limited bandwidth of the link.
BgpV4Status string: Status of the link's BGP IPv4 session.
BgpV6Status string: Status of the link's BGP IPv6 session.
ConnectionId string: Dedicated physical connection supporting the link.
CreatedAt string: Creation date of the link.
EnableRoutePropagation bool: Defines whether route propagation is enabled or not.
Id string: The provider-assigned unique ID for this managed resource.
OrganizationId string: Organization ID.
PairingKey string: Used to identify a link from a user or partner's point of view.
PartnerId string: ID of the partner facilitating the link.
PeerAsn int: For self-hosted links, the peer AS Number to establish BGP session.
PeerBgpConfigs List<Pulumiverse.Scaleway.Interlink.Outputs.GetLinkPeerBgpConfig>: BGP configuration on peer's side (on-premises or other hosting provider).
PopId string: ID of the PoP where the link's corresponding connection is located.
RoutingPolicyV4Id string: ID of the routing policy IPv4 attached to the link.
RoutingPolicyV6Id string: ID of the routing policy IPv6 attached to the link.
ScwBgpConfigs List<Pulumiverse.Scaleway.Interlink.Outputs.GetLinkScwBgpConfig>: BGP configuration on Scaleway's side.
Status string: Status of the link.
Tags List<string>: List of tags associated with the link.
UpdatedAt string: Last modification date of the link.
Vlan int: VLAN of the link.
VpcId string: ID of the Scaleway VPC attached to the link.
LinkId string
Name string
ProjectId string
Region string

BandwidthMbps int: Rate limited bandwidth of the link.
BgpV4Status string: Status of the link's BGP IPv4 session.
BgpV6Status string: Status of the link's BGP IPv6 session.
ConnectionId string: Dedicated physical connection supporting the link.
CreatedAt string: Creation date of the link.
EnableRoutePropagation bool: Defines whether route propagation is enabled or not.
Id string: The provider-assigned unique ID for this managed resource.
OrganizationId string: Organization ID.
PairingKey string: Used to identify a link from a user or partner's point of view.
PartnerId string: ID of the partner facilitating the link.
PeerAsn int: For self-hosted links, the peer AS Number to establish BGP session.
PeerBgpConfigs []GetLinkPeerBgpConfig: BGP configuration on peer's side (on-premises or other hosting provider).
PopId string: ID of the PoP where the link's corresponding connection is located.
RoutingPolicyV4Id string: ID of the routing policy IPv4 attached to the link.
RoutingPolicyV6Id string: ID of the routing policy IPv6 attached to the link.
ScwBgpConfigs []GetLinkScwBgpConfig: BGP configuration on Scaleway's side.
Status string: Status of the link.
Tags []string: List of tags associated with the link.
UpdatedAt string: Last modification date of the link.
Vlan int: VLAN of the link.
VpcId string: ID of the Scaleway VPC attached to the link.
LinkId string
Name string
ProjectId string
Region string

bandwidthMbps Integer: Rate limited bandwidth of the link.
bgpV4Status String: Status of the link's BGP IPv4 session.
bgpV6Status String: Status of the link's BGP IPv6 session.
connectionId String: Dedicated physical connection supporting the link.
createdAt String: Creation date of the link.
enableRoutePropagation Boolean: Defines whether route propagation is enabled or not.
id String: The provider-assigned unique ID for this managed resource.
organizationId String: Organization ID.
pairingKey String: Used to identify a link from a user or partner's point of view.
partnerId String: ID of the partner facilitating the link.
peerAsn Integer: For self-hosted links, the peer AS Number to establish BGP session.
peerBgpConfigs List<GetLinkPeerBgpConfig>: BGP configuration on peer's side (on-premises or other hosting provider).
popId String: ID of the PoP where the link's corresponding connection is located.
routingPolicyV4Id String: ID of the routing policy IPv4 attached to the link.
routingPolicyV6Id String: ID of the routing policy IPv6 attached to the link.
scwBgpConfigs List<GetLinkScwBgpConfig>: BGP configuration on Scaleway's side.
status String: Status of the link.
tags List<String>: List of tags associated with the link.
updatedAt String: Last modification date of the link.
vlan Integer: VLAN of the link.
vpcId String: ID of the Scaleway VPC attached to the link.
linkId String
name String
projectId String
region String

bandwidthMbps number: Rate limited bandwidth of the link.
bgpV4Status string: Status of the link's BGP IPv4 session.
bgpV6Status string: Status of the link's BGP IPv6 session.
connectionId string: Dedicated physical connection supporting the link.
createdAt string: Creation date of the link.
enableRoutePropagation boolean: Defines whether route propagation is enabled or not.
id string: The provider-assigned unique ID for this managed resource.
organizationId string: Organization ID.
pairingKey string: Used to identify a link from a user or partner's point of view.
partnerId string: ID of the partner facilitating the link.
peerAsn number: For self-hosted links, the peer AS Number to establish BGP session.
peerBgpConfigs GetLinkPeerBgpConfig[]: BGP configuration on peer's side (on-premises or other hosting provider).
popId string: ID of the PoP where the link's corresponding connection is located.
routingPolicyV4Id string: ID of the routing policy IPv4 attached to the link.
routingPolicyV6Id string: ID of the routing policy IPv6 attached to the link.
scwBgpConfigs GetLinkScwBgpConfig[]: BGP configuration on Scaleway's side.
status string: Status of the link.
tags string[]: List of tags associated with the link.
updatedAt string: Last modification date of the link.
vlan number: VLAN of the link.
vpcId string: ID of the Scaleway VPC attached to the link.
linkId string
name string
projectId string
region string

bandwidth_mbps int: Rate limited bandwidth of the link.
bgp_v4_status str: Status of the link's BGP IPv4 session.
bgp_v6_status str: Status of the link's BGP IPv6 session.
connection_id str: Dedicated physical connection supporting the link.
created_at str: Creation date of the link.
enable_route_propagation bool: Defines whether route propagation is enabled or not.
id str: The provider-assigned unique ID for this managed resource.
organization_id str: Organization ID.
pairing_key str: Used to identify a link from a user or partner's point of view.
partner_id str: ID of the partner facilitating the link.
peer_asn int: For self-hosted links, the peer AS Number to establish BGP session.
peer_bgp_configs Sequence[GetLinkPeerBgpConfig]: BGP configuration on peer's side (on-premises or other hosting provider).
pop_id str: ID of the PoP where the link's corresponding connection is located.
routing_policy_v4_id str: ID of the routing policy IPv4 attached to the link.
routing_policy_v6_id str: ID of the routing policy IPv6 attached to the link.
scw_bgp_configs Sequence[GetLinkScwBgpConfig]: BGP configuration on Scaleway's side.
status str: Status of the link.
tags Sequence[str]: List of tags associated with the link.
updated_at str: Last modification date of the link.
vlan int: VLAN of the link.
vpc_id str: ID of the Scaleway VPC attached to the link.
link_id str
name str
project_id str
region str

bandwidthMbps Number: Rate limited bandwidth of the link.
bgpV4Status String: Status of the link's BGP IPv4 session.
bgpV6Status String: Status of the link's BGP IPv6 session.
connectionId String: Dedicated physical connection supporting the link.
createdAt String: Creation date of the link.
enableRoutePropagation Boolean: Defines whether route propagation is enabled or not.
id String: The provider-assigned unique ID for this managed resource.
organizationId String: Organization ID.
pairingKey String: Used to identify a link from a user or partner's point of view.
partnerId String: ID of the partner facilitating the link.
peerAsn Number: For self-hosted links, the peer AS Number to establish BGP session.
peerBgpConfigs List<Property Map>: BGP configuration on peer's side (on-premises or other hosting provider).
popId String: ID of the PoP where the link's corresponding connection is located.
routingPolicyV4Id String: ID of the routing policy IPv4 attached to the link.
routingPolicyV6Id String: ID of the routing policy IPv6 attached to the link.
scwBgpConfigs List<Property Map>: BGP configuration on Scaleway's side.
status String: Status of the link.
tags List<String>: List of tags associated with the link.
updatedAt String: Last modification date of the link.
vlan Number: VLAN of the link.
vpcId String: ID of the Scaleway VPC attached to the link.
linkId String
name String
projectId String
region String

Supporting Types

GetLinkPeerBgpConfig

Asn int: AS Number of the BGP peer
Ipv4 string: IPv4 address of the BGP peer
Ipv6 string: IPv6 address of the BGP peer

Asn int: AS Number of the BGP peer
Ipv4 string: IPv4 address of the BGP peer
Ipv6 string: IPv6 address of the BGP peer

asn Integer: AS Number of the BGP peer
ipv4 String: IPv4 address of the BGP peer
ipv6 String: IPv6 address of the BGP peer

asn number: AS Number of the BGP peer
ipv4 string: IPv4 address of the BGP peer
ipv6 string: IPv6 address of the BGP peer

asn int: AS Number of the BGP peer
ipv4 str: IPv4 address of the BGP peer
ipv6 str: IPv6 address of the BGP peer

asn Number: AS Number of the BGP peer
ipv4 String: IPv4 address of the BGP peer
ipv6 String: IPv6 address of the BGP peer

GetLinkScwBgpConfig

Asn int: AS Number of the BGP peer
Ipv4 string: IPv4 address of the BGP peer
Ipv6 string: IPv6 address of the BGP peer

Asn int: AS Number of the BGP peer
Ipv4 string: IPv4 address of the BGP peer
Ipv6 string: IPv6 address of the BGP peer

asn Integer: AS Number of the BGP peer
ipv4 String: IPv4 address of the BGP peer
ipv6 String: IPv6 address of the BGP peer

asn number: AS Number of the BGP peer
ipv4 string: IPv4 address of the BGP peer
ipv6 string: IPv6 address of the BGP peer

asn int: AS Number of the BGP peer
ipv4 str: IPv4 address of the BGP peer
ipv6 str: IPv6 address of the BGP peer

asn Number: AS Number of the BGP peer
ipv4 String: IPv4 address of the BGP peer
ipv6 String: IPv6 address of the BGP peer

Package Details

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

Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

scaleway.interlink.getLink

On this page

On this page

Example Usage

Using getLink

getLink Result

Supporting Types

GetLinkPeerBgpConfig

GetLinkScwBgpConfig

Package Details

On this page

On this page