1. Packages
  2. Packages
  3. Scaleway
  4. API Docs
  5. interlink
  6. Link
Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.interlink.Link

scaleway logo
Viewing docs for Scaleway v1.48.0
published on Wednesday, Apr 29, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    Creates and manages Scaleway Interlink Links.

    A link is a logical Interlink session created within a PoP, representing the connection between your infrastructure and Scaleway. Links can be hosted (facilitated by a partner’s shared connection) or self-hosted (using your own dedicated physical connection).

    For more information, see the Interlink documentation and API documentation.

    Example Usage

    Basic

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

const pop = scaleway.interlink.getPop({
    name: "Telehouse TH2",
});
const partner = scaleway.interlink.getPartner({
    name: "FranceIX",
});
const main = new scaleway.interlink.Link("main", {
    name: "my-hosted-link",
    popId: pop.then(pop => pop.id),
    partnerId: partner.then(partner => partner.id),
    bandwidthMbps: 50,
});

    import pulumi
import pulumi_scaleway as scaleway
import pulumiverse_scaleway as scaleway

pop = scaleway.interlink.get_pop(name="Telehouse TH2")
partner = scaleway.interlink.get_partner(name="FranceIX")
main = scaleway.interlink.Link("main",
    name="my-hosted-link",
    pop_id=pop.id,
    partner_id=partner.id,
    bandwidth_mbps=50)

    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 {
		pop, err := interlink.GetPop(ctx, &interlink.GetPopArgs{
			Name: pulumi.StringRef("Telehouse TH2"),
		}, nil)
		if err != nil {
			return err
		}
		partner, err := interlink.GetPartner(ctx, &interlink.GetPartnerArgs{
			Name: pulumi.StringRef("FranceIX"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = interlink.NewLink(ctx, "main", &interlink.LinkArgs{
			Name:          pulumi.String("my-hosted-link"),
			PopId:         pulumi.String(pulumi.String(pop.Id)),
			PartnerId:     pulumi.String(pulumi.String(partner.Id)),
			BandwidthMbps: pulumi.Int(50),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pop = Scaleway.Interlink.GetPop.Invoke(new()
    {
        Name = "Telehouse TH2",
    });

    var partner = Scaleway.Interlink.GetPartner.Invoke(new()
    {
        Name = "FranceIX",
    });

    var main = new Scaleway.Interlink.Link("main", new()
    {
        Name = "my-hosted-link",
        PopId = pop.Apply(getPopResult => getPopResult.Id),
        PartnerId = partner.Apply(getPartnerResult => getPartnerResult.Id),
        BandwidthMbps = 50,
    });

});

    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.GetPopArgs;
import com.pulumi.scaleway.interlink.inputs.GetPartnerArgs;
import com.pulumi.scaleway.interlink.Link;
import com.pulumi.scaleway.interlink.LinkArgs;
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) {
        final var pop = InterlinkFunctions.getPop(GetPopArgs.builder()
            .name("Telehouse TH2")
            .build());

        final var partner = InterlinkFunctions.getPartner(GetPartnerArgs.builder()
            .name("FranceIX")
            .build());

        var main = new Link("main", LinkArgs.builder()
            .name("my-hosted-link")
            .popId(pop.id())
            .partnerId(partner.id())
            .bandwidthMbps(50)
            .build());

    }
}

    resources:
  main:
    type: scaleway:interlink:Link
    properties:
      name: my-hosted-link
      popId: ${pop.id}
      partnerId: ${partner.id}
      bandwidthMbps: 50
variables:
  pop:
    fn::invoke:
      function: scaleway:interlink:getPop
      arguments:
        name: Telehouse TH2
  partner:
    fn::invoke:
      function: scaleway:interlink:getPartner
      arguments:
        name: FranceIX

    With VPC

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

const pop = scaleway.interlink.getPop({
    name: "Telehouse TH2",
});
const partner = scaleway.interlink.getPartner({
    name: "FranceIX",
});
const vpc = new scaleway.network.Vpc("vpc", {name: "my-vpc"});
const main = new scaleway.interlink.Link("main", {
    name: "my-hosted-link",
    popId: pop.then(pop => pop.id),
    partnerId: partner.then(partner => partner.id),
    bandwidthMbps: 50,
    vpcId: vpc.id,
});

    import pulumi
import pulumi_scaleway as scaleway
import pulumiverse_scaleway as scaleway

pop = scaleway.interlink.get_pop(name="Telehouse TH2")
partner = scaleway.interlink.get_partner(name="FranceIX")
vpc = scaleway.network.Vpc("vpc", name="my-vpc")
main = scaleway.interlink.Link("main",
    name="my-hosted-link",
    pop_id=pop.id,
    partner_id=partner.id,
    bandwidth_mbps=50,
    vpc_id=vpc.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pop, err := interlink.GetPop(ctx, &interlink.GetPopArgs{
			Name: pulumi.StringRef("Telehouse TH2"),
		}, nil)
		if err != nil {
			return err
		}
		partner, err := interlink.GetPartner(ctx, &interlink.GetPartnerArgs{
			Name: pulumi.StringRef("FranceIX"),
		}, nil)
		if err != nil {
			return err
		}
		vpc, err := network.NewVpc(ctx, "vpc", &network.VpcArgs{
			Name: pulumi.String("my-vpc"),
		})
		if err != nil {
			return err
		}
		_, err = interlink.NewLink(ctx, "main", &interlink.LinkArgs{
			Name:          pulumi.String("my-hosted-link"),
			PopId:         pulumi.String(pulumi.String(pop.Id)),
			PartnerId:     pulumi.String(pulumi.String(partner.Id)),
			BandwidthMbps: pulumi.Int(50),
			VpcId:         vpc.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pop = Scaleway.Interlink.GetPop.Invoke(new()
    {
        Name = "Telehouse TH2",
    });

    var partner = Scaleway.Interlink.GetPartner.Invoke(new()
    {
        Name = "FranceIX",
    });

    var vpc = new Scaleway.Network.Vpc("vpc", new()
    {
        Name = "my-vpc",
    });

    var main = new Scaleway.Interlink.Link("main", new()
    {
        Name = "my-hosted-link",
        PopId = pop.Apply(getPopResult => getPopResult.Id),
        PartnerId = partner.Apply(getPartnerResult => getPartnerResult.Id),
        BandwidthMbps = 50,
        VpcId = vpc.Id,
    });

});

    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.GetPopArgs;
import com.pulumi.scaleway.interlink.inputs.GetPartnerArgs;
import com.pulumi.scaleway.network.Vpc;
import com.pulumi.scaleway.network.VpcArgs;
import com.pulumi.scaleway.interlink.Link;
import com.pulumi.scaleway.interlink.LinkArgs;
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) {
        final var pop = InterlinkFunctions.getPop(GetPopArgs.builder()
            .name("Telehouse TH2")
            .build());

        final var partner = InterlinkFunctions.getPartner(GetPartnerArgs.builder()
            .name("FranceIX")
            .build());

        var vpc = new Vpc("vpc", VpcArgs.builder()
            .name("my-vpc")
            .build());

        var main = new Link("main", LinkArgs.builder()
            .name("my-hosted-link")
            .popId(pop.id())
            .partnerId(partner.id())
            .bandwidthMbps(50)
            .vpcId(vpc.id())
            .build());

    }
}

    resources:
  vpc:
    type: scaleway:network:Vpc
    properties:
      name: my-vpc
  main:
    type: scaleway:interlink:Link
    properties:
      name: my-hosted-link
      popId: ${pop.id}
      partnerId: ${partner.id}
      bandwidthMbps: 50
      vpcId: ${vpc.id}
variables:
  pop:
    fn::invoke:
      function: scaleway:interlink:getPop
      arguments:
        name: Telehouse TH2
  partner:
    fn::invoke:
      function: scaleway:interlink:getPartner
      arguments:
        name: FranceIX

    Create Link Resource

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

    Constructor syntax

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

@overload
def Link(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         bandwidth_mbps: Optional[int] = None,
         pop_id: Optional[str] = None,
         name: Optional[str] = None,
         enable_route_propagation: Optional[bool] = None,
         partner_id: Optional[str] = None,
         peer_asn: Optional[int] = None,
         connection_id: Optional[str] = None,
         project_id: Optional[str] = None,
         region: Optional[str] = None,
         routing_policy_v4_id: Optional[str] = None,
         routing_policy_v6_id: Optional[str] = None,
         tags: Optional[Sequence[str]] = None,
         vlan: Optional[int] = None,
         vpc_id: Optional[str] = None)
    func NewLink(ctx *Context, name string, args LinkArgs, opts ...ResourceOption) (*Link, error)
    public Link(string name, LinkArgs args, CustomResourceOptions? opts = null)
    public Link(String name, LinkArgs args)
public Link(String name, LinkArgs args, CustomResourceOptions options)

    type: scaleway:interlink:Link
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 LinkArgs
    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 LinkArgs
    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 LinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    BandwidthMbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    PopId string
    PoP (location) where the link will be created.
    ConnectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    EnableRoutePropagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    Name string
    Name of the link. If not provided, a name will be randomly generated.
    PartnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    PeerAsn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    ProjectId string
    projectId) The ID of the project the link is associated with.
    Region string
    region) The region in which the link should be created.
    RoutingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    RoutingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    Tags List<string>
    List of tags to apply to the link.
    Vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    VpcId string
    ID of the Scaleway VPC to attach to the link.
    BandwidthMbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    PopId string
    PoP (location) where the link will be created.
    ConnectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    EnableRoutePropagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    Name string
    Name of the link. If not provided, a name will be randomly generated.
    PartnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    PeerAsn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    ProjectId string
    projectId) The ID of the project the link is associated with.
    Region string
    region) The region in which the link should be created.
    RoutingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    RoutingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    Tags []string
    List of tags to apply to the link.
    Vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    VpcId string
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps Integer
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    popId String
    PoP (location) where the link will be created.
    connectionId String
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    enableRoutePropagation Boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name String
    Name of the link. If not provided, a name will be randomly generated.
    partnerId String
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn Integer
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    projectId String
    projectId) The ID of the project the link is associated with.
    region String
    region) The region in which the link should be created.
    routingPolicyV4Id String
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id String
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    tags List<String>
    List of tags to apply to the link.
    vlan Integer
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId String
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps number
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    popId string
    PoP (location) where the link will be created.
    connectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    enableRoutePropagation boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name string
    Name of the link. If not provided, a name will be randomly generated.
    partnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn number
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    projectId string
    projectId) The ID of the project the link is associated with.
    region string
    region) The region in which the link should be created.
    routingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    tags string[]
    List of tags to apply to the link.
    vlan number
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId string
    ID of the Scaleway VPC to attach to the link.
    bandwidth_mbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    pop_id str
    PoP (location) where the link will be created.
    connection_id str
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    enable_route_propagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    name str
    Name of the link. If not provided, a name will be randomly generated.
    partner_id str
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peer_asn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    project_id str
    projectId) The ID of the project the link is associated with.
    region str
    region) The region in which the link should be created.
    routing_policy_v4_id str
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routing_policy_v6_id str
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    tags Sequence[str]
    List of tags to apply to the link.
    vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpc_id str
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps Number
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    popId String
    PoP (location) where the link will be created.
    connectionId String
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    enableRoutePropagation Boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name String
    Name of the link. If not provided, a name will be randomly generated.
    partnerId String
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn Number
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    projectId String
    projectId) The ID of the project the link is associated with.
    region String
    region) The region in which the link should be created.
    routingPolicyV4Id String
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id String
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    tags List<String>
    List of tags to apply to the link.
    vlan Number
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId String
    ID of the Scaleway VPC to attach to the link.

    Outputs

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

    BgpV4Status string
    Status of the link's BGP IPv4 session.
    BgpV6Status string
    Status of the link's BGP IPv6 session.
    CreatedAt string
    Creation date of the link (RFC 3339 format).
    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.
    PeerBgpConfigs List<Pulumiverse.Scaleway.Interlink.Outputs.LinkPeerBgpConfig>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    ScwBgpConfigs List<Pulumiverse.Scaleway.Interlink.Outputs.LinkScwBgpConfig>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    Status string
    Status of the link.
    UpdatedAt string
    Last modification date of the link (RFC 3339 format).
    BgpV4Status string
    Status of the link's BGP IPv4 session.
    BgpV6Status string
    Status of the link's BGP IPv6 session.
    CreatedAt string
    Creation date of the link (RFC 3339 format).
    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.
    PeerBgpConfigs []LinkPeerBgpConfig
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    ScwBgpConfigs []LinkScwBgpConfig
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    Status string
    Status of the link.
    UpdatedAt string
    Last modification date of the link (RFC 3339 format).
    bgpV4Status String
    Status of the link's BGP IPv4 session.
    bgpV6Status String
    Status of the link's BGP IPv6 session.
    createdAt String
    Creation date of the link (RFC 3339 format).
    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.
    peerBgpConfigs List<LinkPeerBgpConfig>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    scwBgpConfigs List<LinkScwBgpConfig>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status String
    Status of the link.
    updatedAt String
    Last modification date of the link (RFC 3339 format).
    bgpV4Status string
    Status of the link's BGP IPv4 session.
    bgpV6Status string
    Status of the link's BGP IPv6 session.
    createdAt string
    Creation date of the link (RFC 3339 format).
    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.
    peerBgpConfigs LinkPeerBgpConfig[]
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    scwBgpConfigs LinkScwBgpConfig[]
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status string
    Status of the link.
    updatedAt string
    Last modification date of the link (RFC 3339 format).
    bgp_v4_status str
    Status of the link's BGP IPv4 session.
    bgp_v6_status str
    Status of the link's BGP IPv6 session.
    created_at str
    Creation date of the link (RFC 3339 format).
    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.
    peer_bgp_configs Sequence[LinkPeerBgpConfig]
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    scw_bgp_configs Sequence[LinkScwBgpConfig]
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status str
    Status of the link.
    updated_at str
    Last modification date of the link (RFC 3339 format).
    bgpV4Status String
    Status of the link's BGP IPv4 session.
    bgpV6Status String
    Status of the link's BGP IPv6 session.
    createdAt String
    Creation date of the link (RFC 3339 format).
    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.
    peerBgpConfigs List<Property Map>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    scwBgpConfigs List<Property Map>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status String
    Status of the link.
    updatedAt String
    Last modification date of the link (RFC 3339 format).

    Look up Existing Link Resource

    Get an existing Link 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?: LinkState, opts?: CustomResourceOptions): Link
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth_mbps: Optional[int] = None,
        bgp_v4_status: Optional[str] = None,
        bgp_v6_status: Optional[str] = None,
        connection_id: Optional[str] = None,
        created_at: Optional[str] = None,
        enable_route_propagation: Optional[bool] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        pairing_key: Optional[str] = None,
        partner_id: Optional[str] = None,
        peer_asn: Optional[int] = None,
        peer_bgp_configs: Optional[Sequence[LinkPeerBgpConfigArgs]] = None,
        pop_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        routing_policy_v4_id: Optional[str] = None,
        routing_policy_v6_id: Optional[str] = None,
        scw_bgp_configs: Optional[Sequence[LinkScwBgpConfigArgs]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        vlan: Optional[int] = None,
        vpc_id: Optional[str] = None) -> Link
    func GetLink(ctx *Context, name string, id IDInput, state *LinkState, opts ...ResourceOption) (*Link, error)
    public static Link Get(string name, Input<string> id, LinkState? state, CustomResourceOptions? opts = null)
    public static Link get(String name, Output<String> id, LinkState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:interlink:Link    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:
    BandwidthMbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    BgpV4Status string
    Status of the link's BGP IPv4 session.
    BgpV6Status string
    Status of the link's BGP IPv6 session.
    ConnectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    CreatedAt string
    Creation date of the link (RFC 3339 format).
    EnableRoutePropagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    Name string
    Name of the link. If not provided, a name will be randomly generated.
    OrganizationId string
    Organization ID.
    PairingKey string
    Used to identify a link from a user or partner's point of view.
    PartnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    PeerAsn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    PeerBgpConfigs List<Pulumiverse.Scaleway.Interlink.Inputs.LinkPeerBgpConfig>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    PopId string
    PoP (location) where the link will be created.
    ProjectId string
    projectId) The ID of the project the link is associated with.
    Region string
    region) The region in which the link should be created.
    RoutingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    RoutingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    ScwBgpConfigs List<Pulumiverse.Scaleway.Interlink.Inputs.LinkScwBgpConfig>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    Status string
    Status of the link.
    Tags List<string>
    List of tags to apply to the link.
    UpdatedAt string
    Last modification date of the link (RFC 3339 format).
    Vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    VpcId string
    ID of the Scaleway VPC to attach to the link.
    BandwidthMbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    BgpV4Status string
    Status of the link's BGP IPv4 session.
    BgpV6Status string
    Status of the link's BGP IPv6 session.
    ConnectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    CreatedAt string
    Creation date of the link (RFC 3339 format).
    EnableRoutePropagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    Name string
    Name of the link. If not provided, a name will be randomly generated.
    OrganizationId string
    Organization ID.
    PairingKey string
    Used to identify a link from a user or partner's point of view.
    PartnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    PeerAsn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    PeerBgpConfigs []LinkPeerBgpConfigArgs
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    PopId string
    PoP (location) where the link will be created.
    ProjectId string
    projectId) The ID of the project the link is associated with.
    Region string
    region) The region in which the link should be created.
    RoutingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    RoutingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    ScwBgpConfigs []LinkScwBgpConfigArgs
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    Status string
    Status of the link.
    Tags []string
    List of tags to apply to the link.
    UpdatedAt string
    Last modification date of the link (RFC 3339 format).
    Vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    VpcId string
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps Integer
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    bgpV4Status String
    Status of the link's BGP IPv4 session.
    bgpV6Status String
    Status of the link's BGP IPv6 session.
    connectionId String
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    createdAt String
    Creation date of the link (RFC 3339 format).
    enableRoutePropagation Boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name String
    Name of the link. If not provided, a name will be randomly generated.
    organizationId String
    Organization ID.
    pairingKey String
    Used to identify a link from a user or partner's point of view.
    partnerId String
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn Integer
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    peerBgpConfigs List<LinkPeerBgpConfig>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    popId String
    PoP (location) where the link will be created.
    projectId String
    projectId) The ID of the project the link is associated with.
    region String
    region) The region in which the link should be created.
    routingPolicyV4Id String
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id String
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    scwBgpConfigs List<LinkScwBgpConfig>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status String
    Status of the link.
    tags List<String>
    List of tags to apply to the link.
    updatedAt String
    Last modification date of the link (RFC 3339 format).
    vlan Integer
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId String
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps number
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    bgpV4Status string
    Status of the link's BGP IPv4 session.
    bgpV6Status string
    Status of the link's BGP IPv6 session.
    connectionId string
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    createdAt string
    Creation date of the link (RFC 3339 format).
    enableRoutePropagation boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name string
    Name of the link. If not provided, a name will be randomly generated.
    organizationId string
    Organization ID.
    pairingKey string
    Used to identify a link from a user or partner's point of view.
    partnerId string
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn number
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    peerBgpConfigs LinkPeerBgpConfig[]
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    popId string
    PoP (location) where the link will be created.
    projectId string
    projectId) The ID of the project the link is associated with.
    region string
    region) The region in which the link should be created.
    routingPolicyV4Id string
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id string
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    scwBgpConfigs LinkScwBgpConfig[]
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status string
    Status of the link.
    tags string[]
    List of tags to apply to the link.
    updatedAt string
    Last modification date of the link (RFC 3339 format).
    vlan number
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId string
    ID of the Scaleway VPC to attach to the link.
    bandwidth_mbps int
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    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
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    created_at str
    Creation date of the link (RFC 3339 format).
    enable_route_propagation bool
    Defines whether route propagation is enabled or not. Defaults to false.
    name str
    Name of the link. If not provided, a name will be randomly generated.
    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
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peer_asn int
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    peer_bgp_configs Sequence[LinkPeerBgpConfigArgs]
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    pop_id str
    PoP (location) where the link will be created.
    project_id str
    projectId) The ID of the project the link is associated with.
    region str
    region) The region in which the link should be created.
    routing_policy_v4_id str
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routing_policy_v6_id str
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    scw_bgp_configs Sequence[LinkScwBgpConfigArgs]
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status str
    Status of the link.
    tags Sequence[str]
    List of tags to apply to the link.
    updated_at str
    Last modification date of the link (RFC 3339 format).
    vlan int
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpc_id str
    ID of the Scaleway VPC to attach to the link.
    bandwidthMbps Number
    Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.
    bgpV4Status String
    Status of the link's BGP IPv4 session.
    bgpV6Status String
    Status of the link's BGP IPv6 session.
    connectionId String
    If set, creates a self-hosted link using this dedicated physical connection. Conflicts with partnerId.
    createdAt String
    Creation date of the link (RFC 3339 format).
    enableRoutePropagation Boolean
    Defines whether route propagation is enabled or not. Defaults to false.
    name String
    Name of the link. If not provided, a name will be randomly generated.
    organizationId String
    Organization ID.
    pairingKey String
    Used to identify a link from a user or partner's point of view.
    partnerId String
    If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. Conflicts with connectionId.
    peerAsn Number
    For self-hosted links, the peer AS Number to establish BGP session. If not given, a default one will be assigned.
    peerBgpConfigs List<Property Map>
    BGP configuration on peer's side (on-premises or other hosting provider). Contains asn, ipv4, ipv6.
    popId String
    PoP (location) where the link will be created.
    projectId String
    projectId) The ID of the project the link is associated with.
    region String
    region) The region in which the link should be created.
    routingPolicyV4Id String
    If set, attaches this routing policy containing IPv4 prefixes to the link. A BGP IPv4 session will be created.
    routingPolicyV6Id String
    If set, attaches this routing policy containing IPv6 prefixes to the link. A BGP IPv6 session will be created.
    scwBgpConfigs List<Property Map>
    BGP configuration on Scaleway's side. Contains asn, ipv4, ipv6.
    status String
    Status of the link.
    tags List<String>
    List of tags to apply to the link.
    updatedAt String
    Last modification date of the link (RFC 3339 format).
    vlan Number
    For self-hosted links only, the VLAN ID. If the VLAN is not available (already taken or out of range), an error is returned.
    vpcId String
    ID of the Scaleway VPC to attach to the link.

    Supporting Types

    LinkPeerBgpConfig, LinkPeerBgpConfigArgs

    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

    LinkScwBgpConfig, LinkScwBgpConfigArgs

    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

    Import

    Interlink Links can be imported using {region}/{id}, e.g.

    $ pulumi import scaleway:interlink/link:Link main fr-par/11111111-1111-1111-1111-111111111111

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

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.48.0
    published on Wednesday, Apr 29, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway
      Try Pulumi Cloud free. Your team will thank you.