confluentcloud.NetworkLinkService
Explore with Pulumi AI
Example Usage
Example Network Link Service on AWS
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const development = new confluentcloud.Environment("development", {displayName: "Development"});
const aws_private_link = new confluentcloud.Network("aws-private-link", {
displayName: "AWS Private Link Network",
cloud: "AWS",
region: "us-east-1",
connectionTypes: ["PRIVATELINK"],
zones: [
"use1-az1",
"use1-az2",
"use1-az6",
],
environment: {
id: development.id,
},
});
const awsNls = new confluentcloud.NetworkLinkService("aws_nls", {
displayName: "AWS Private Link network link service",
environment: {
id: development.id,
},
network: {
id: aws_private_link.id,
},
description: "Test NL service",
accept: {
environments: [
"env-5678",
"env-0923",
],
networks: ["n-1234"],
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
development = confluentcloud.Environment("development", display_name="Development")
aws_private_link = confluentcloud.Network("aws-private-link",
display_name="AWS Private Link Network",
cloud="AWS",
region="us-east-1",
connection_types=["PRIVATELINK"],
zones=[
"use1-az1",
"use1-az2",
"use1-az6",
],
environment={
"id": development.id,
})
aws_nls = confluentcloud.NetworkLinkService("aws_nls",
display_name="AWS Private Link network link service",
environment={
"id": development.id,
},
network={
"id": aws_private_link.id,
},
description="Test NL service",
accept={
"environments": [
"env-5678",
"env-0923",
],
"networks": ["n-1234"],
})
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 {
development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
DisplayName: pulumi.String("Development"),
})
if err != nil {
return err
}
_, err = confluentcloud.NewNetwork(ctx, "aws-private-link", &confluentcloud.NetworkArgs{
DisplayName: pulumi.String("AWS Private Link Network"),
Cloud: pulumi.String("AWS"),
Region: pulumi.String("us-east-1"),
ConnectionTypes: pulumi.StringArray{
pulumi.String("PRIVATELINK"),
},
Zones: pulumi.StringArray{
pulumi.String("use1-az1"),
pulumi.String("use1-az2"),
pulumi.String("use1-az6"),
},
Environment: &confluentcloud.NetworkEnvironmentArgs{
Id: development.ID(),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewNetworkLinkService(ctx, "aws_nls", &confluentcloud.NetworkLinkServiceArgs{
DisplayName: pulumi.String("AWS Private Link network link service"),
Environment: &confluentcloud.NetworkLinkServiceEnvironmentArgs{
Id: development.ID(),
},
Network: &confluentcloud.NetworkLinkServiceNetworkArgs{
Id: aws_private_link.ID(),
},
Description: pulumi.String("Test NL service"),
Accept: &confluentcloud.NetworkLinkServiceAcceptArgs{
Environments: pulumi.StringArray{
pulumi.String("env-5678"),
pulumi.String("env-0923"),
},
Networks: pulumi.StringArray{
pulumi.String("n-1234"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var development = new ConfluentCloud.Environment("development", new()
{
DisplayName = "Development",
});
var aws_private_link = new ConfluentCloud.Network("aws-private-link", new()
{
DisplayName = "AWS Private Link Network",
Cloud = "AWS",
Region = "us-east-1",
ConnectionTypes = new[]
{
"PRIVATELINK",
},
Zones = new[]
{
"use1-az1",
"use1-az2",
"use1-az6",
},
Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
{
Id = development.Id,
},
});
var awsNls = new ConfluentCloud.NetworkLinkService("aws_nls", new()
{
DisplayName = "AWS Private Link network link service",
Environment = new ConfluentCloud.Inputs.NetworkLinkServiceEnvironmentArgs
{
Id = development.Id,
},
Network = new ConfluentCloud.Inputs.NetworkLinkServiceNetworkArgs
{
Id = aws_private_link.Id,
},
Description = "Test NL service",
Accept = new ConfluentCloud.Inputs.NetworkLinkServiceAcceptArgs
{
Environments = new[]
{
"env-5678",
"env-0923",
},
Networks = new[]
{
"n-1234",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.NetworkLinkService;
import com.pulumi.confluentcloud.NetworkLinkServiceArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkServiceEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkServiceNetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkLinkServiceAcceptArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
.displayName("Development")
.build());
var aws_private_link = new Network("aws-private-link", NetworkArgs.builder()
.displayName("AWS Private Link Network")
.cloud("AWS")
.region("us-east-1")
.connectionTypes("PRIVATELINK")
.zones(
"use1-az1",
"use1-az2",
"use1-az6")
.environment(NetworkEnvironmentArgs.builder()
.id(development.id())
.build())
.build());
var awsNls = new NetworkLinkService("awsNls", NetworkLinkServiceArgs.builder()
.displayName("AWS Private Link network link service")
.environment(NetworkLinkServiceEnvironmentArgs.builder()
.id(development.id())
.build())
.network(NetworkLinkServiceNetworkArgs.builder()
.id(aws_private_link.id())
.build())
.description("Test NL service")
.accept(NetworkLinkServiceAcceptArgs.builder()
.environments(
"env-5678",
"env-0923")
.networks("n-1234")
.build())
.build());
}
}
resources:
development:
type: confluentcloud:Environment
properties:
displayName: Development
aws-private-link:
type: confluentcloud:Network
properties:
displayName: AWS Private Link Network
cloud: AWS
region: us-east-1
connectionTypes:
- PRIVATELINK
zones:
- use1-az1
- use1-az2
- use1-az6
environment:
id: ${development.id}
awsNls:
type: confluentcloud:NetworkLinkService
name: aws_nls
properties:
displayName: AWS Private Link network link service
environment:
id: ${development.id}
network:
id: ${["aws-private-link"].id}
description: Test NL service
accept:
environments:
- env-5678
- env-0923
networks:
- n-1234
Getting Started
The following end-to-end examples might help to get started with confluentcloud.NetworkLinkService
resource:
cluster-link-over-aws-private-link-networks
: Cluster link over two dedicated clusters in separate AWS PrivateLink networks
Create NetworkLinkService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkLinkService(name: string, args: NetworkLinkServiceArgs, opts?: CustomResourceOptions);
@overload
def NetworkLinkService(resource_name: str,
args: NetworkLinkServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkLinkService(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment: Optional[NetworkLinkServiceEnvironmentArgs] = None,
network: Optional[NetworkLinkServiceNetworkArgs] = None,
accept: Optional[NetworkLinkServiceAcceptArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None)
func NewNetworkLinkService(ctx *Context, name string, args NetworkLinkServiceArgs, opts ...ResourceOption) (*NetworkLinkService, error)
public NetworkLinkService(string name, NetworkLinkServiceArgs args, CustomResourceOptions? opts = null)
public NetworkLinkService(String name, NetworkLinkServiceArgs args)
public NetworkLinkService(String name, NetworkLinkServiceArgs args, CustomResourceOptions options)
type: confluentcloud:NetworkLinkService
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 NetworkLinkServiceArgs
- 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 NetworkLinkServiceArgs
- 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 NetworkLinkServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkLinkServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkLinkServiceArgs
- 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 networkLinkServiceResource = new ConfluentCloud.NetworkLinkService("networkLinkServiceResource", new()
{
Environment = new ConfluentCloud.Inputs.NetworkLinkServiceEnvironmentArgs
{
Id = "string",
},
Network = new ConfluentCloud.Inputs.NetworkLinkServiceNetworkArgs
{
Id = "string",
},
Accept = new ConfluentCloud.Inputs.NetworkLinkServiceAcceptArgs
{
Environments = new[]
{
"string",
},
Networks = new[]
{
"string",
},
},
Description = "string",
DisplayName = "string",
});
example, err := confluentcloud.NewNetworkLinkService(ctx, "networkLinkServiceResource", &confluentcloud.NetworkLinkServiceArgs{
Environment: &confluentcloud.NetworkLinkServiceEnvironmentArgs{
Id: pulumi.String("string"),
},
Network: &confluentcloud.NetworkLinkServiceNetworkArgs{
Id: pulumi.String("string"),
},
Accept: &confluentcloud.NetworkLinkServiceAcceptArgs{
Environments: pulumi.StringArray{
pulumi.String("string"),
},
Networks: pulumi.StringArray{
pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
})
var networkLinkServiceResource = new NetworkLinkService("networkLinkServiceResource", NetworkLinkServiceArgs.builder()
.environment(NetworkLinkServiceEnvironmentArgs.builder()
.id("string")
.build())
.network(NetworkLinkServiceNetworkArgs.builder()
.id("string")
.build())
.accept(NetworkLinkServiceAcceptArgs.builder()
.environments("string")
.networks("string")
.build())
.description("string")
.displayName("string")
.build());
network_link_service_resource = confluentcloud.NetworkLinkService("networkLinkServiceResource",
environment={
"id": "string",
},
network={
"id": "string",
},
accept={
"environments": ["string"],
"networks": ["string"],
},
description="string",
display_name="string")
const networkLinkServiceResource = new confluentcloud.NetworkLinkService("networkLinkServiceResource", {
environment: {
id: "string",
},
network: {
id: "string",
},
accept: {
environments: ["string"],
networks: ["string"],
},
description: "string",
displayName: "string",
});
type: confluentcloud:NetworkLinkService
properties:
accept:
environments:
- string
networks:
- string
description: string
displayName: string
environment:
id: string
network:
id: string
NetworkLinkService 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 NetworkLinkService resource accepts the following input properties:
- Environment
Pulumi.
Confluent Cloud. Inputs. Network Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Pulumi.
Confluent Cloud. Inputs. Network Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Accept
Pulumi.
Confluent Cloud. Inputs. Network Link Service Accept - Description string
- The description of the Network Link Service.
- Display
Name string - The name of the Network Link Service.
- Environment
Network
Link Service Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Network
Link Service Network Args - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Accept
Network
Link Service Accept Args - Description string
- The description of the Network Link Service.
- Display
Name string - The name of the Network Link Service.
- environment
Network
Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- accept
Network
Link Service Accept - description String
- The description of the Network Link Service.
- display
Name String - The name of the Network Link Service.
- environment
Network
Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- accept
Network
Link Service Accept - description string
- The description of the Network Link Service.
- display
Name string - The name of the Network Link Service.
- environment
Network
Link Service Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network Args - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- accept
Network
Link Service Accept Args - description str
- The description of the Network Link Service.
- display_
name str - The name of the Network Link Service.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network Property Map
- Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- accept Property Map
- description String
- The description of the Network Link Service.
- display
Name String - The name of the Network Link Service.
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkLinkService resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Name String - (Required String) The Confluent Resource Name of the Network Link Service.
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
name str - (Required String) The Confluent Resource Name of the Network Link Service.
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Name String - (Required String) The Confluent Resource Name of the Network Link Service.
Look up Existing NetworkLinkService Resource
Get an existing NetworkLinkService 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?: NetworkLinkServiceState, opts?: CustomResourceOptions): NetworkLinkService
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accept: Optional[NetworkLinkServiceAcceptArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
environment: Optional[NetworkLinkServiceEnvironmentArgs] = None,
network: Optional[NetworkLinkServiceNetworkArgs] = None,
resource_name: Optional[str] = None) -> NetworkLinkService
func GetNetworkLinkService(ctx *Context, name string, id IDInput, state *NetworkLinkServiceState, opts ...ResourceOption) (*NetworkLinkService, error)
public static NetworkLinkService Get(string name, Input<string> id, NetworkLinkServiceState? state, CustomResourceOptions? opts = null)
public static NetworkLinkService get(String name, Output<String> id, NetworkLinkServiceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Accept
Pulumi.
Confluent Cloud. Inputs. Network Link Service Accept - Description string
- The description of the Network Link Service.
- Display
Name string - The name of the Network Link Service.
- Environment
Pulumi.
Confluent Cloud. Inputs. Network Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Pulumi.
Confluent Cloud. Inputs. Network Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- Accept
Network
Link Service Accept Args - Description string
- The description of the Network Link Service.
- Display
Name string - The name of the Network Link Service.
- Environment
Network
Link Service Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Network
Link Service Network Args - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- accept
Network
Link Service Accept - description String
- The description of the Network Link Service.
- display
Name String - The name of the Network Link Service.
- environment
Network
Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- resource
Name String - (Required String) The Confluent Resource Name of the Network Link Service.
- accept
Network
Link Service Accept - description string
- The description of the Network Link Service.
- display
Name string - The name of the Network Link Service.
- environment
Network
Link Service Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- resource
Name string - (Required String) The Confluent Resource Name of the Network Link Service.
- accept
Network
Link Service Accept Args - description str
- The description of the Network Link Service.
- display_
name str - The name of the Network Link Service.
- environment
Network
Link Service Environment Args - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Network
Link Service Network Args - Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- resource_
name str - (Required String) The Confluent Resource Name of the Network Link Service.
- accept Property Map
- description String
- The description of the Network Link Service.
- display
Name String - The name of the Network Link Service.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network Property Map
- Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- resource
Name String - (Required String) The Confluent Resource Name of the Network Link Service.
Supporting Types
NetworkLinkServiceAccept, NetworkLinkServiceAcceptArgs
- Environments List<string>
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- Networks List<string>
- List of network ids from which connections can be accepted.
- Environments []string
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- Networks []string
- List of network ids from which connections can be accepted.
- environments List<String>
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- networks List<String>
- List of network ids from which connections can be accepted.
- environments string[]
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- networks string[]
- List of network ids from which connections can be accepted.
- environments Sequence[str]
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- networks Sequence[str]
- List of network ids from which connections can be accepted.
- environments List<String>
- List of environments ids from which connections can be accepted. All networks within the list of environment will be allowed.
- networks List<String>
- List of network ids from which connections can be accepted.
NetworkLinkServiceEnvironment, NetworkLinkServiceEnvironmentArgs
- Id string
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
- Id string
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
- id string
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
- id str
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the Network Link Service belongs to, for example,
env-abc123
.
NetworkLinkServiceNetwork, NetworkLinkServiceNetworkArgs
- Id string
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
- Id string
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
- id String
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
- id string
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
- id str
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
- id String
- The ID of the Network that the Network Link Service belongs to, for example,
n-abc123
.
Import
You can import a Network Link Service by using Environment ID and Network Link Service ID, in the format <Environment ID>/<Network Link Service ID>
. The following example shows how to import a Network Link Service:
$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/networkLinkService:NetworkLinkService my_nls env-abc123/nls-abc123
!> 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.