Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getNetworkLinkService
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getNetworkLinkService

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

confluentcloud.NetworkLinkService describes a Network Link Service data source.

Example Usage

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

const nls = confluentcloud.getNetworkLinkService({
    id: "nls-zyw30",
    environment: {
        id: "env-1234",
    },
});
export const networkLinkService = nls;
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

nls = confluentcloud.get_network_link_service(id="nls-zyw30",
    environment={
        "id": "env-1234",
    })
pulumi.export("networkLinkService", nls)
Copy
package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		nls, err := confluentcloud.LookupNetworkLinkService(ctx, &confluentcloud.LookupNetworkLinkServiceArgs{
			Id: pulumi.StringRef("nls-zyw30"),
			Environment: confluentcloud.GetNetworkLinkServiceEnvironment{
				Id: "env-1234",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkLinkService", nls)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var nls = ConfluentCloud.GetNetworkLinkService.Invoke(new()
    {
        Id = "nls-zyw30",
        Environment = new ConfluentCloud.Inputs.GetNetworkLinkServiceEnvironmentInputArgs
        {
            Id = "env-1234",
        },
    });

    return new Dictionary<string, object?>
    {
        ["networkLinkService"] = nls,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetNetworkLinkServiceArgs;
import com.pulumi.confluentcloud.inputs.GetNetworkLinkServiceEnvironmentArgs;
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 nls = ConfluentcloudFunctions.getNetworkLinkService(GetNetworkLinkServiceArgs.builder()
            .id("nls-zyw30")
            .environment(GetNetworkLinkServiceEnvironmentArgs.builder()
                .id("env-1234")
                .build())
            .build());

        ctx.export("networkLinkService", nls.applyValue(getNetworkLinkServiceResult -> getNetworkLinkServiceResult));
    }
}
Copy
variables:
  nls:
    fn::invoke:
      function: confluentcloud:getNetworkLinkService
      arguments:
        id: nls-zyw30
        environment:
          id: env-1234
outputs:
  networkLinkService: ${nls}
Copy

Using getNetworkLinkService

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 getNetworkLinkService(args: GetNetworkLinkServiceArgs, opts?: InvokeOptions): Promise<GetNetworkLinkServiceResult>
function getNetworkLinkServiceOutput(args: GetNetworkLinkServiceOutputArgs, opts?: InvokeOptions): Output<GetNetworkLinkServiceResult>
Copy
def get_network_link_service(accept: Optional[GetNetworkLinkServiceAccept] = None,
                             display_name: Optional[str] = None,
                             environment: Optional[GetNetworkLinkServiceEnvironment] = None,
                             id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetNetworkLinkServiceResult
def get_network_link_service_output(accept: Optional[pulumi.Input[GetNetworkLinkServiceAcceptArgs]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             environment: Optional[pulumi.Input[GetNetworkLinkServiceEnvironmentArgs]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetNetworkLinkServiceResult]
Copy
func LookupNetworkLinkService(ctx *Context, args *LookupNetworkLinkServiceArgs, opts ...InvokeOption) (*LookupNetworkLinkServiceResult, error)
func LookupNetworkLinkServiceOutput(ctx *Context, args *LookupNetworkLinkServiceOutputArgs, opts ...InvokeOption) LookupNetworkLinkServiceResultOutput
Copy

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

public static class GetNetworkLinkService 
{
    public static Task<GetNetworkLinkServiceResult> InvokeAsync(GetNetworkLinkServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkLinkServiceResult> Invoke(GetNetworkLinkServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkLinkServiceResult> getNetworkLinkService(GetNetworkLinkServiceArgs args, InvokeOptions options)
public static Output<GetNetworkLinkServiceResult> getNetworkLinkService(GetNetworkLinkServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: confluentcloud:index/getNetworkLinkService:getNetworkLinkService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Environment This property is required. Pulumi.ConfluentCloud.Inputs.GetNetworkLinkServiceEnvironment
Accept Pulumi.ConfluentCloud.Inputs.GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
DisplayName string
The Display Name of the Network Link Service, for example, DR Link
Id string
The ID of the Network Link Service, for example, nls-zyw30.
Environment This property is required. GetNetworkLinkServiceEnvironment
Accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
DisplayName string
The Display Name of the Network Link Service, for example, DR Link
Id string
The ID of the Network Link Service, for example, nls-zyw30.
environment This property is required. GetNetworkLinkServiceEnvironment
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
displayName String
The Display Name of the Network Link Service, for example, DR Link
id String
The ID of the Network Link Service, for example, nls-zyw30.
environment This property is required. GetNetworkLinkServiceEnvironment
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
displayName string
The Display Name of the Network Link Service, for example, DR Link
id string
The ID of the Network Link Service, for example, nls-zyw30.
environment This property is required. GetNetworkLinkServiceEnvironment
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
display_name str
The Display Name of the Network Link Service, for example, DR Link
id str
The ID of the Network Link Service, for example, nls-zyw30.
environment This property is required. Property Map
accept Property Map
(Optional Configuration Block) supports the following:
displayName String
The Display Name of the Network Link Service, for example, DR Link
id String
The ID of the Network Link Service, for example, nls-zyw30.

getNetworkLinkService Result

The following output properties are available:

Accept Pulumi.ConfluentCloud.Outputs.GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
Description string
(Optional String) The description of the Network Link Service.
DisplayName string
(Optional String) The name of the Network Link Service.
Environment Pulumi.ConfluentCloud.Outputs.GetNetworkLinkServiceEnvironment
Id string
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
Networks List<Pulumi.ConfluentCloud.Outputs.GetNetworkLinkServiceNetwork>
(Required Configuration Block) supports the following:
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Service.
Accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
Description string
(Optional String) The description of the Network Link Service.
DisplayName string
(Optional String) The name of the Network Link Service.
Environment GetNetworkLinkServiceEnvironment
Id string
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
Networks []GetNetworkLinkServiceNetwork
(Required Configuration Block) supports the following:
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Service.
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
description String
(Optional String) The description of the Network Link Service.
displayName String
(Optional String) The name of the Network Link Service.
environment GetNetworkLinkServiceEnvironment
id String
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
networks List<GetNetworkLinkServiceNetwork>
(Required Configuration Block) supports the following:
resourceName String
(Required String) The Confluent Resource Name of the Network Link Service.
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
description string
(Optional String) The description of the Network Link Service.
displayName string
(Optional String) The name of the Network Link Service.
environment GetNetworkLinkServiceEnvironment
id string
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
networks GetNetworkLinkServiceNetwork[]
(Required Configuration Block) supports the following:
resourceName string
(Required String) The Confluent Resource Name of the Network Link Service.
accept GetNetworkLinkServiceAccept
(Optional Configuration Block) supports the following:
description str
(Optional String) The description of the Network Link Service.
display_name str
(Optional String) The name of the Network Link Service.
environment GetNetworkLinkServiceEnvironment
id str
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
networks Sequence[GetNetworkLinkServiceNetwork]
(Required Configuration Block) supports the following:
resource_name str
(Required String) The Confluent Resource Name of the Network Link Service.
accept Property Map
(Optional Configuration Block) supports the following:
description String
(Optional String) The description of the Network Link Service.
displayName String
(Optional String) The name of the Network Link Service.
environment Property Map
id String
(Required String) The ID of the Network that the Network Link Service belongs to, for example, n-abc123.
networks List<Property Map>
(Required Configuration Block) supports the following:
resourceName String
(Required String) The Confluent Resource Name of the Network Link Service.

Supporting Types

GetNetworkLinkServiceAccept

Environments This property is required. List<string>
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
Networks This property is required. List<string>
(Optional List of Strings) List of network ids from which connections can be accepted.
Environments This property is required. []string
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
Networks This property is required. []string
(Optional List of Strings) List of network ids from which connections can be accepted.
environments This property is required. List<String>
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
networks This property is required. List<String>
(Optional List of Strings) List of network ids from which connections can be accepted.
environments This property is required. string[]
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
networks This property is required. string[]
(Optional List of Strings) List of network ids from which connections can be accepted.
environments This property is required. Sequence[str]
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
networks This property is required. Sequence[str]
(Optional List of Strings) List of network ids from which connections can be accepted.
environments This property is required. List<String>
(Optional List of Strings) List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
networks This property is required. List<String>
(Optional List of Strings) List of network ids from which connections can be accepted.

GetNetworkLinkServiceEnvironment

Id This property is required. string

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

Id This property is required. string

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

id This property is required. String

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

id This property is required. string

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

id This property is required. str

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

id This property is required. String

The ID of the Environment that the Network Link Service belongs to, for example, env-1234.

Note: Exactly one from the id and display_name attributes must be specified.

GetNetworkLinkServiceNetwork

Id This property is required. string
The ID of the Network Link Service, for example, nls-zyw30.
Id This property is required. string
The ID of the Network Link Service, for example, nls-zyw30.
id This property is required. String
The ID of the Network Link Service, for example, nls-zyw30.
id This property is required. string
The ID of the Network Link Service, for example, nls-zyw30.
id This property is required. str
The ID of the Network Link Service, for example, nls-zyw30.
id This property is required. String
The ID of the Network Link Service, for example, nls-zyw30.

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud