1. Packages
  2. Confluent Provider
  3. API Docs
  4. NetworkLinkEndpoint
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi

confluentcloud.NetworkLinkEndpoint

Explore with Pulumi AI

Example Usage

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

const nle = new confluentcloud.NetworkLinkEndpoint("nle", {
    displayName: "nle1",
    description: "TEST-NLE1",
    environment: {
        id: "env-xyz456",
    },
    network: {
        id: "n-abc123",
    },
    networkLinkService: {
        id: "nls-g3e1ox",
    },
});
export const networkLinkEndpoint = nle;
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

nle = confluentcloud.NetworkLinkEndpoint("nle",
    display_name="nle1",
    description="TEST-NLE1",
    environment={
        "id": "env-xyz456",
    },
    network={
        "id": "n-abc123",
    },
    network_link_service={
        "id": "nls-g3e1ox",
    })
pulumi.export("networkLinkEndpoint", nle)
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 {
		nle, err := confluentcloud.NewNetworkLinkEndpoint(ctx, "nle", &confluentcloud.NetworkLinkEndpointArgs{
			DisplayName: pulumi.String("nle1"),
			Description: pulumi.String("TEST-NLE1"),
			Environment: &confluentcloud.NetworkLinkEndpointEnvironmentArgs{
				Id: pulumi.String("env-xyz456"),
			},
			Network: &confluentcloud.NetworkLinkEndpointNetworkArgs{
				Id: pulumi.String("n-abc123"),
			},
			NetworkLinkService: &confluentcloud.NetworkLinkEndpointNetworkLinkServiceArgs{
				Id: pulumi.String("nls-g3e1ox"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("networkLinkEndpoint", nle)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var nle = new ConfluentCloud.NetworkLinkEndpoint("nle", new()
    {
        DisplayName = "nle1",
        Description = "TEST-NLE1",
        Environment = new ConfluentCloud.Inputs.NetworkLinkEndpointEnvironmentArgs
        {
            Id = "env-xyz456",
        },
        Network = new ConfluentCloud.Inputs.NetworkLinkEndpointNetworkArgs
        {
            Id = "n-abc123",
        },
        NetworkLinkService = new ConfluentCloud.Inputs.NetworkLinkEndpointNetworkLinkServiceArgs
        {
            Id = "nls-g3e1ox",
        },
    });

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

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.NetworkLinkEndpoint;
import com.pulumi.confluentcloud.NetworkLinkEndpointArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkEndpointEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkEndpointNetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkEndpointNetworkLinkServiceArgs;
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) {
        var nle = new NetworkLinkEndpoint("nle", NetworkLinkEndpointArgs.builder()
            .displayName("nle1")
            .description("TEST-NLE1")
            .environment(NetworkLinkEndpointEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .network(NetworkLinkEndpointNetworkArgs.builder()
                .id("n-abc123")
                .build())
            .networkLinkService(NetworkLinkEndpointNetworkLinkServiceArgs.builder()
                .id("nls-g3e1ox")
                .build())
            .build());

        ctx.export("networkLinkEndpoint", nle);
    }
}
Copy
resources:
  nle:
    type: confluentcloud:NetworkLinkEndpoint
    properties:
      displayName: nle1
      description: TEST-NLE1
      environment:
        id: env-xyz456
      network:
        id: n-abc123
      networkLinkService:
        id: nls-g3e1ox
outputs:
  networkLinkEndpoint: ${nle}
Copy

Getting Started

The following end-to-end examples might help to get started with confluentcloud.NetworkLinkEndpoint resource:

  • cluster-link-over-aws-private-link-networks: Cluster link over two dedicated clusters in separate AWS PrivateLink networks

Create NetworkLinkEndpoint Resource

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

Constructor syntax

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

@overload
def NetworkLinkEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        environment: Optional[NetworkLinkEndpointEnvironmentArgs] = None,
                        network: Optional[NetworkLinkEndpointNetworkArgs] = None,
                        network_link_service: Optional[NetworkLinkEndpointNetworkLinkServiceArgs] = None,
                        description: Optional[str] = None,
                        display_name: Optional[str] = None)
func NewNetworkLinkEndpoint(ctx *Context, name string, args NetworkLinkEndpointArgs, opts ...ResourceOption) (*NetworkLinkEndpoint, error)
public NetworkLinkEndpoint(string name, NetworkLinkEndpointArgs args, CustomResourceOptions? opts = null)
public NetworkLinkEndpoint(String name, NetworkLinkEndpointArgs args)
public NetworkLinkEndpoint(String name, NetworkLinkEndpointArgs args, CustomResourceOptions options)
type: confluentcloud:NetworkLinkEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NetworkLinkEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NetworkLinkEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkLinkEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkLinkEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkLinkEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var networkLinkEndpointResource = new ConfluentCloud.NetworkLinkEndpoint("networkLinkEndpointResource", new()
{
    Environment = new ConfluentCloud.Inputs.NetworkLinkEndpointEnvironmentArgs
    {
        Id = "string",
    },
    Network = new ConfluentCloud.Inputs.NetworkLinkEndpointNetworkArgs
    {
        Id = "string",
    },
    NetworkLinkService = new ConfluentCloud.Inputs.NetworkLinkEndpointNetworkLinkServiceArgs
    {
        Id = "string",
    },
    Description = "string",
    DisplayName = "string",
});
Copy
example, err := confluentcloud.NewNetworkLinkEndpoint(ctx, "networkLinkEndpointResource", &confluentcloud.NetworkLinkEndpointArgs{
	Environment: &confluentcloud.NetworkLinkEndpointEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	Network: &confluentcloud.NetworkLinkEndpointNetworkArgs{
		Id: pulumi.String("string"),
	},
	NetworkLinkService: &confluentcloud.NetworkLinkEndpointNetworkLinkServiceArgs{
		Id: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
})
Copy
var networkLinkEndpointResource = new NetworkLinkEndpoint("networkLinkEndpointResource", NetworkLinkEndpointArgs.builder()
    .environment(NetworkLinkEndpointEnvironmentArgs.builder()
        .id("string")
        .build())
    .network(NetworkLinkEndpointNetworkArgs.builder()
        .id("string")
        .build())
    .networkLinkService(NetworkLinkEndpointNetworkLinkServiceArgs.builder()
        .id("string")
        .build())
    .description("string")
    .displayName("string")
    .build());
Copy
network_link_endpoint_resource = confluentcloud.NetworkLinkEndpoint("networkLinkEndpointResource",
    environment={
        "id": "string",
    },
    network={
        "id": "string",
    },
    network_link_service={
        "id": "string",
    },
    description="string",
    display_name="string")
Copy
const networkLinkEndpointResource = new confluentcloud.NetworkLinkEndpoint("networkLinkEndpointResource", {
    environment: {
        id: "string",
    },
    network: {
        id: "string",
    },
    networkLinkService: {
        id: "string",
    },
    description: "string",
    displayName: "string",
});
Copy
type: confluentcloud:NetworkLinkEndpoint
properties:
    description: string
    displayName: string
    environment:
        id: string
    network:
        id: string
    networkLinkService:
        id: string
Copy

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

Environment
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
NetworkLinkService
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointNetworkLinkService
Description string
The description of the Network Link Endpoint.
DisplayName string
The name of the Network Link Endpoint.
Environment
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
NetworkLinkService
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkLinkServiceArgs
Description string
The description of the Network Link Endpoint.
DisplayName string
The name of the Network Link Endpoint.
environment
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkLinkService
description String
The description of the Network Link Endpoint.
displayName String
The name of the Network Link Endpoint.
environment
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkLinkService
description string
The description of the Network Link Endpoint.
displayName string
The name of the Network Link Endpoint.
environment
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
network_link_service
This property is required.
Changes to this property will trigger replacement.
NetworkLinkEndpointNetworkLinkServiceArgs
description str
The description of the Network Link Endpoint.
display_name str
The name of the Network Link Endpoint.
environment
This property is required.
Changes to this property will trigger replacement.
Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService
This property is required.
Changes to this property will trigger replacement.
Property Map
description String
The description of the Network Link Endpoint.
displayName String
The name of the Network Link Endpoint.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
Id string
The provider-assigned unique ID for this managed resource.
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
id String
The provider-assigned unique ID for this managed resource.
resourceName String
(Required String) The Confluent Resource Name of the Network Link Endpoint.
id string
The provider-assigned unique ID for this managed resource.
resourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
id str
The provider-assigned unique ID for this managed resource.
resource_name str
(Required String) The Confluent Resource Name of the Network Link Endpoint.
id String
The provider-assigned unique ID for this managed resource.
resourceName String
(Required String) The Confluent Resource Name of the Network Link Endpoint.

Look up Existing NetworkLinkEndpoint Resource

Get an existing NetworkLinkEndpoint 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?: NetworkLinkEndpointState, opts?: CustomResourceOptions): NetworkLinkEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        environment: Optional[NetworkLinkEndpointEnvironmentArgs] = None,
        network: Optional[NetworkLinkEndpointNetworkArgs] = None,
        network_link_service: Optional[NetworkLinkEndpointNetworkLinkServiceArgs] = None,
        resource_name: Optional[str] = None) -> NetworkLinkEndpoint
func GetNetworkLinkEndpoint(ctx *Context, name string, id IDInput, state *NetworkLinkEndpointState, opts ...ResourceOption) (*NetworkLinkEndpoint, error)
public static NetworkLinkEndpoint Get(string name, Input<string> id, NetworkLinkEndpointState? state, CustomResourceOptions? opts = null)
public static NetworkLinkEndpoint get(String name, Output<String> id, NetworkLinkEndpointState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:NetworkLinkEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description of the Network Link Endpoint.
DisplayName string
The name of the Network Link Endpoint.
Environment Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
NetworkLinkService Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.NetworkLinkEndpointNetworkLinkService
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
Description string
The description of the Network Link Endpoint.
DisplayName string
The name of the Network Link Endpoint.
Environment Changes to this property will trigger replacement. NetworkLinkEndpointEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network Changes to this property will trigger replacement. NetworkLinkEndpointNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
NetworkLinkService Changes to this property will trigger replacement. NetworkLinkEndpointNetworkLinkServiceArgs
ResourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
description String
The description of the Network Link Endpoint.
displayName String
The name of the Network Link Endpoint.
environment Changes to this property will trigger replacement. NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network Changes to this property will trigger replacement. NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService Changes to this property will trigger replacement. NetworkLinkEndpointNetworkLinkService
resourceName String
(Required String) The Confluent Resource Name of the Network Link Endpoint.
description string
The description of the Network Link Endpoint.
displayName string
The name of the Network Link Endpoint.
environment Changes to this property will trigger replacement. NetworkLinkEndpointEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network Changes to this property will trigger replacement. NetworkLinkEndpointNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService Changes to this property will trigger replacement. NetworkLinkEndpointNetworkLinkService
resourceName string
(Required String) The Confluent Resource Name of the Network Link Endpoint.
description str
The description of the Network Link Endpoint.
display_name str
The name of the Network Link Endpoint.
environment Changes to this property will trigger replacement. NetworkLinkEndpointEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network Changes to this property will trigger replacement. NetworkLinkEndpointNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
network_link_service Changes to this property will trigger replacement. NetworkLinkEndpointNetworkLinkServiceArgs
resource_name str
(Required String) The Confluent Resource Name of the Network Link Endpoint.
description String
The description of the Network Link Endpoint.
displayName String
The name of the Network Link Endpoint.
environment Changes to this property will trigger replacement. Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network Changes to this property will trigger replacement. Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
networkLinkService Changes to this property will trigger replacement. Property Map
resourceName String
(Required String) The Confluent Resource Name of the Network Link Endpoint.

Supporting Types

NetworkLinkEndpointEnvironment
, NetworkLinkEndpointEnvironmentArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Network Link Endpoint belongs to, for example, env-xyz456.

NetworkLinkEndpointNetwork
, NetworkLinkEndpointNetworkArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network that the Network Link Endpoint belongs to, for example, n-abc123.

NetworkLinkEndpointNetworkLinkService
, NetworkLinkEndpointNetworkLinkServiceArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network Link Service, for example, nls-g3e1ox.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network Link Service, for example, nls-g3e1ox.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network Link Service, for example, nls-g3e1ox.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network Link Service, for example, nls-g3e1ox.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Network Link Service, for example, nls-g3e1ox.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network Link Service, for example, nls-g3e1ox.

Import

You can import a Network Link Endpoint by using Environment ID and Network Link Endpoint ID, in the format <Environment ID>/<Network Link Endpoint ID>. The following example shows how to import a Network Link Endpoint:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ pulumi import confluentcloud:index/networkLinkEndpoint:NetworkLinkEndpoint my_nle env-abc123/nle-abc123
Copy

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.