1. Packages
  2. Scaleway
  3. API Docs
  4. network
  5. getConnector
Viewing docs for Scaleway v1.46.0
published on Tuesday, Apr 14, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.46.0
published on Tuesday, Apr 14, 2026 by pulumiverse

    Gets information about a VPC connector.

    A VPC connector enables network connectivity between two VPCs, allowing resources in separate VPCs to communicate with each other.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    // Retrieve a VPC connector by its ID
    const byId = scaleway.network.getConnector({
        connectorId: "fr-par/11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    # Retrieve a VPC connector by its ID
    by_id = scaleway.network.get_connector(connector_id="fr-par/11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/network"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Retrieve a VPC connector by its ID
    		_, err := network.LookupConnector(ctx, &network.LookupConnectorArgs{
    			ConnectorId: pulumi.StringRef("fr-par/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(() => 
    {
        // Retrieve a VPC connector by its ID
        var byId = Scaleway.Network.GetConnector.Invoke(new()
        {
            ConnectorId = "fr-par/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.network.NetworkFunctions;
    import com.pulumi.scaleway.network.inputs.GetConnectorArgs;
    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) {
            // Retrieve a VPC connector by its ID
            final var byId = NetworkFunctions.getConnector(GetConnectorArgs.builder()
                .connectorId("fr-par/11111111-1111-1111-1111-111111111111")
                .build());
    
        }
    }
    
    variables:
      # Retrieve a VPC connector by its ID
      byId:
        fn::invoke:
          function: scaleway:network:getConnector
          arguments:
            connectorId: fr-par/11111111-1111-1111-1111-111111111111
    
    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    // Retrieve a VPC connector by name
    const byName = scaleway.network.getConnector({
        name: "my-vpc-connector",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    # Retrieve a VPC connector by name
    by_name = scaleway.network.get_connector(name="my-vpc-connector")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/network"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Retrieve a VPC connector by name
    		_, err := network.LookupConnector(ctx, &network.LookupConnectorArgs{
    			Name: pulumi.StringRef("my-vpc-connector"),
    		}, 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(() => 
    {
        // Retrieve a VPC connector by name
        var byName = Scaleway.Network.GetConnector.Invoke(new()
        {
            Name = "my-vpc-connector",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.network.NetworkFunctions;
    import com.pulumi.scaleway.network.inputs.GetConnectorArgs;
    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) {
            // Retrieve a VPC connector by name
            final var byName = NetworkFunctions.getConnector(GetConnectorArgs.builder()
                .name("my-vpc-connector")
                .build());
    
        }
    }
    
    variables:
      # Retrieve a VPC connector by name
      byName:
        fn::invoke:
          function: scaleway:network:getConnector
          arguments:
            name: my-vpc-connector
    

    Using getConnector

    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 getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
    function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
    def get_connector(connector_id: Optional[str] = None,
                      name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      region: Optional[str] = None,
                      tags: Optional[Sequence[str]] = None,
                      target_vpc_id: Optional[str] = None,
                      vpc_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConnectorResult
    def get_connector_output(connector_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,
                      tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      target_vpc_id: Optional[pulumi.Input[str]] = None,
                      vpc_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
    func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
    func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

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

    public static class GetConnector 
    {
        public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scaleway:network/getConnector:getConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectorId string

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    Name string
    The name to filter for.
    ProjectId string
    The ID of the Project to filter for.
    Region string
    region) The region in which the connector exists.
    Tags List<string>
    List of tags to filter for.
    TargetVpcId string
    The target VPC ID to filter for.
    VpcId string
    The source VPC ID to filter for.
    ConnectorId string

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    Name string
    The name to filter for.
    ProjectId string
    The ID of the Project to filter for.
    Region string
    region) The region in which the connector exists.
    Tags []string
    List of tags to filter for.
    TargetVpcId string
    The target VPC ID to filter for.
    VpcId string
    The source VPC ID to filter for.
    connectorId String

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    name String
    The name to filter for.
    projectId String
    The ID of the Project to filter for.
    region String
    region) The region in which the connector exists.
    tags List<String>
    List of tags to filter for.
    targetVpcId String
    The target VPC ID to filter for.
    vpcId String
    The source VPC ID to filter for.
    connectorId string

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    name string
    The name to filter for.
    projectId string
    The ID of the Project to filter for.
    region string
    region) The region in which the connector exists.
    tags string[]
    List of tags to filter for.
    targetVpcId string
    The target VPC ID to filter for.
    vpcId string
    The source VPC ID to filter for.
    connector_id str

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    name str
    The name to filter for.
    project_id str
    The ID of the Project to filter for.
    region str
    region) The region in which the connector exists.
    tags Sequence[str]
    List of tags to filter for.
    target_vpc_id str
    The target VPC ID to filter for.
    vpc_id str
    The source VPC ID to filter for.
    connectorId String

    The ID of the VPC connector. Conflicts with all filter arguments below.

    The following arguments can be used to look up a VPC connector via the list API. They all conflict with connectorId:

    name String
    The name to filter for.
    projectId String
    The ID of the Project to filter for.
    region String
    region) The region in which the connector exists.
    tags List<String>
    List of tags to filter for.
    targetVpcId String
    The target VPC ID to filter for.
    vpcId String
    The source VPC ID to filter for.

    getConnector Result

    The following output properties are available:

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    Status string
    UpdatedAt string
    ConnectorId string
    Name string
    ProjectId string
    Region string
    Tags List<string>
    TargetVpcId string
    VpcId string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    Status string
    UpdatedAt string
    ConnectorId string
    Name string
    ProjectId string
    Region string
    Tags []string
    TargetVpcId string
    VpcId string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    status String
    updatedAt String
    connectorId String
    name String
    projectId String
    region String
    tags List<String>
    targetVpcId String
    vpcId String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    status string
    updatedAt string
    connectorId string
    name string
    projectId string
    region string
    tags string[]
    targetVpcId string
    vpcId string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    status str
    updated_at str
    connector_id str
    name str
    project_id str
    region str
    tags Sequence[str]
    target_vpc_id str
    vpc_id str
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    status String
    updatedAt String
    connectorId String
    name String
    projectId String
    region String
    tags List<String>
    targetVpcId String
    vpcId String

    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.46.0
    published on Tuesday, Apr 14, 2026 by pulumiverse
      Try Pulumi Cloud free. Your team will thank you.