Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
confluentcloud.Network describes a Network data source.
Example Usage
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
class MyStack : Stack
{
public MyStack()
{
var exampleUsingId = Output.Create(ConfluentCloud.GetNetwork.InvokeAsync(new ConfluentCloud.GetNetworkArgs
{
Id = "n-abc123",
Environment = new ConfluentCloud.Inputs.GetNetworkEnvironmentArgs
{
Id = "env-xyz456",
},
}));
var test_sa = new ConfluentCloud.ServiceAccount("test-sa", new ConfluentCloud.ServiceAccountArgs
{
DisplayName = "test_sa",
Description = exampleUsingId.Apply(exampleUsingId => $"test_sa for {exampleUsingId.DisplayName}"),
});
var exampleUsingNameNetwork = Output.Create(ConfluentCloud.GetNetwork.InvokeAsync(new ConfluentCloud.GetNetworkArgs
{
DisplayName = "my_network",
Environment = new ConfluentCloud.Inputs.GetNetworkEnvironmentArgs
{
Id = "env-xyz456",
},
}));
this.ExampleUsingName = exampleUsingNameNetwork;
}
[Output("exampleUsingName")]
public Output<string> ExampleUsingName { get; set; }
}
package main
import (
"fmt"
"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleUsingId, err := confluentcloud.LookupNetwork(ctx, &GetNetworkArgs{
Id: pulumi.StringRef("n-abc123"),
Environment: GetNetworkEnvironment{
Id: "env-xyz456",
},
}, nil)
if err != nil {
return err
}
_, err = confluentcloud.NewServiceAccount(ctx, "test-sa", &confluentcloud.ServiceAccountArgs{
DisplayName: pulumi.String("test_sa"),
Description: pulumi.String(fmt.Sprintf("%v%v", "test_sa for ", exampleUsingId.DisplayName)),
})
if err != nil {
return err
}
exampleUsingNameNetwork, err := confluentcloud.LookupNetwork(ctx, &GetNetworkArgs{
DisplayName: pulumi.StringRef("my_network"),
Environment: GetNetworkEnvironment{
Id: "env-xyz456",
},
}, nil)
if err != nil {
return err
}
ctx.Export("exampleUsingName", exampleUsingNameNetwork)
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var exampleUsingId = Output.of(ConfluentcloudFunctions.getNetwork(GetNetworkArgs.builder()
.id("n-abc123")
.environment(GetNetworkEnvironmentArgs.builder()
.id("env-xyz456")
.build())
.build()));
var test_sa = new ServiceAccount("test-sa", ServiceAccountArgs.builder()
.displayName("test_sa")
.description(String.format("test_sa for %s", exampleUsingId.apply(getNetworkResult -> getNetworkResult.displayName())))
.build());
final var exampleUsingNameNetwork = Output.of(ConfluentcloudFunctions.getNetwork(GetNetworkArgs.builder()
.displayName("my_network")
.environment(GetNetworkEnvironmentArgs.builder()
.id("env-xyz456")
.build())
.build()));
ctx.export("exampleUsingName", exampleUsingNameNetwork.apply(getNetworkResult -> getNetworkResult));
}
}
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const exampleUsingId = confluentcloud.getNetwork({
id: "n-abc123",
environment: {
id: "env-xyz456",
},
});
const test_sa = new confluentcloud.ServiceAccount("test-sa", {
displayName: "test_sa",
description: exampleUsingId.then(exampleUsingId => `test_sa for ${exampleUsingId.displayName}`),
});
const exampleUsingNameNetwork = confluentcloud.getNetwork({
displayName: "my_network",
environment: {
id: "env-xyz456",
},
});
export const exampleUsingName = exampleUsingNameNetwork;
import pulumi
import pulumi_confluentcloud as confluentcloud
example_using_id = confluentcloud.get_network(id="n-abc123",
environment=confluentcloud.GetNetworkEnvironmentArgs(
id="env-xyz456",
))
test_sa = confluentcloud.ServiceAccount("test-sa",
display_name="test_sa",
description=f"test_sa for {example_using_id.display_name}")
example_using_name_network = confluentcloud.get_network(display_name="my_network",
environment=confluentcloud.GetNetworkEnvironmentArgs(
id="env-xyz456",
))
pulumi.export("exampleUsingName", example_using_name_network)
resources:
test-sa:
type: confluentcloud:ServiceAccount
properties:
displayName: test_sa
description: test_sa for ${exampleUsingId.displayName}
variables:
exampleUsingId:
Fn::Invoke:
Function: confluentcloud:getNetwork
Arguments:
id: n-abc123
environment:
id: env-xyz456
exampleUsingNameNetwork:
Fn::Invoke:
Function: confluentcloud:getNetwork
Arguments:
displayName: my_network
environment:
id: env-xyz456
outputs:
exampleUsingName: ${exampleUsingNameNetwork}
Using getNetwork
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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>def get_network(aws: Optional[Sequence[GetNetworkAw]] = None,
azures: Optional[Sequence[GetNetworkAzure]] = None,
display_name: Optional[str] = None,
environment: Optional[GetNetworkEnvironment] = None,
gcps: Optional[Sequence[GetNetworkGcp]] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(aws: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkAwArgs]]]] = None,
azures: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkAzureArgs]]]] = None,
display_name: Optional[pulumi.Input[str]] = None,
environment: Optional[pulumi.Input[GetNetworkEnvironmentArgs]] = None,
gcps: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkGcpArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput> Note: This function is named LookupNetwork in the Go SDK.
public static class GetNetwork
{
public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
fn::invoke:
function: confluentcloud:index/getNetwork:getNetwork
arguments:
# arguments dictionaryThe following arguments are supported:
- Environment
Pulumi.
Confluent Cloud. Inputs. Get Network Environment - Aws
List<Pulumi.
Confluent Cloud. Inputs. Get Network Aw> - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- Azures
List<Pulumi.
Confluent Cloud. Inputs. Get Network Azure> - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- Display
Name string - A human-readable name for the Network.
- Gcps
List<Pulumi.
Confluent Cloud. Inputs. Get Network Gcp> - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- Id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- Environment
Get
Network Environment - Aws
[]Get
Network Aw - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- Azures
[]Get
Network Azure - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- Display
Name string - A human-readable name for the Network.
- Gcps
[]Get
Network Gcp - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- Id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- environment
Get
Network Environment - aws
List<Get
Network Aw> - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
List<Get
Network Azure> - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- display
Name String - A human-readable name for the Network.
- gcps
List<Get
Network Gcp> - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id String
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- environment
Get
Network Environment - aws
Get
Network Aw[] - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
Get
Network Azure[] - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- display
Name string - A human-readable name for the Network.
- gcps
Get
Network Gcp[] - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- environment
Get
Network Environment - aws
Sequence[Get
Network Aw] - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
Sequence[Get
Network Azure] - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- display_
name str - A human-readable name for the Network.
- gcps
Sequence[Get
Network Gcp] - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id str
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- environment Property Map
- aws List<Property Map>
- (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures List<Property Map>
- (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- display
Name String - A human-readable name for the Network.
- gcps List<Property Map>
- (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id String
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
getNetwork Result
The following output properties are available:
- Aws
List<Pulumi.
Confluent Cloud. Outputs. Get Network Aw> - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- Azures
List<Pulumi.
Confluent Cloud. Outputs. Get Network Azure> - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- Cidr string
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - Cloud string
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - Connection
Types List<string> - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - Display
Name string - (Required String) The name of the Network.
- Dns
Domain string - Environment
Pulumi.
Confluent Cloud. Outputs. Get Network Environment - Gcps
List<Pulumi.
Confluent Cloud. Outputs. Get Network Gcp> - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- Id string
- (Required String) The ID of the Network, for example,
n-abc123. - Region string
- (Required String) The cloud provider region where the network exists.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network.
- Zonal
Subdomains Dictionary<string, string> - Zones List<string>
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
- Aws
[]Get
Network Aw - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- Azures
[]Get
Network Azure - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- Cidr string
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - Cloud string
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - Connection
Types []string - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - Display
Name string - (Required String) The name of the Network.
- Dns
Domain string - Environment
Get
Network Environment - Gcps
[]Get
Network Gcp - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- Id string
- (Required String) The ID of the Network, for example,
n-abc123. - Region string
- (Required String) The cloud provider region where the network exists.
- Resource
Name string - (Required String) The Confluent Resource Name of the Network.
- Zonal
Subdomains map[string]string - Zones []string
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
- aws
List<Get
Network Aw> - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
List<Get
Network Azure> - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- cidr String
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - cloud String
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - connection
Types List<String> - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - display
Name String - (Required String) The name of the Network.
- dns
Domain String - environment
Get
Network Environment - gcps
List<Get
Network Gcp> - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id String
- (Required String) The ID of the Network, for example,
n-abc123. - region String
- (Required String) The cloud provider region where the network exists.
- resource
Name String - (Required String) The Confluent Resource Name of the Network.
- zonal
Subdomains Map<String,String> - zones List<String>
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
- aws
Get
Network Aw[] - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
Get
Network Azure[] - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- cidr string
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - cloud string
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - connection
Types string[] - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - display
Name string - (Required String) The name of the Network.
- dns
Domain string - environment
Get
Network Environment - gcps
Get
Network Gcp[] - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id string
- (Required String) The ID of the Network, for example,
n-abc123. - region string
- (Required String) The cloud provider region where the network exists.
- resource
Name string - (Required String) The Confluent Resource Name of the Network.
- zonal
Subdomains {[key: string]: string} - zones string[]
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
- aws
Sequence[Get
Network Aw] - (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures
Sequence[Get
Network Azure] - (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- cidr str
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - cloud str
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - connection_
types Sequence[str] - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - display_
name str - (Required String) The name of the Network.
- dns_
domain str - environment
Get
Network Environment - gcps
Sequence[Get
Network Gcp] - (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id str
- (Required String) The ID of the Network, for example,
n-abc123. - region str
- (Required String) The cloud provider region where the network exists.
- resource_
name str - (Required String) The Confluent Resource Name of the Network.
- zonal_
subdomains Mapping[str, str] - zones Sequence[str]
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
- aws List<Property Map>
- (Optional Configuration Block) The AWS-specific network details if available. It supports the following:
- azures List<Property Map>
- (Optional Configuration Block) The Azure-specific network details if available. It supports the following:
- cidr String
- (Required String) The IPv4 CIDR block to used for the network. Must be
/16. Required for VPC peering and AWS TransitGateway. - cloud String
- (Required String) The cloud service provider in which the network exists. Accepted values are:
AWS,AZURE, andGCP. - connection
Types List<String> - (Required List of String) The list of connection types that may be used with the network. Accepted connection types are:
PEERING,TRANSITGATEWAY, andPRIVATELINK. - display
Name String - (Required String) The name of the Network.
- dns
Domain String - environment Property Map
- gcps List<Property Map>
- (Optional Configuration Block) The GCP-specific network details if available. It supports the following:
- id String
- (Required String) The ID of the Network, for example,
n-abc123. - region String
- (Required String) The cloud provider region where the network exists.
- resource
Name String - (Required String) The Confluent Resource Name of the Network.
- zonal
Subdomains Map<String> - zones List<String>
- (Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks
used with Private Link. Otherwise, they are automatically chosen by Confluent Cloud.
On AWS, zones are AWS AZ IDs, for example,
use1-az3. On GCP, zones are GCP zones, for example,us-central1-c. On Azure, zones are Confluent-chosen names (for example,1,2,3) since Azure does not have universal zone identifiers.
Supporting Types
GetNetworkAw
- Private
Link stringEndpoint Service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- Vpc string
- (Required String) The AWS VPC ID for the network.
- Private
Link stringEndpoint Service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- Vpc string
- (Required String) The AWS VPC ID for the network.
- private
Link StringEndpoint Service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- vpc String
- (Required String) The AWS VPC ID for the network.
- private
Link stringEndpoint Service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- vpc string
- (Required String) The AWS VPC ID for the network.
- private_
link_ strendpoint_ service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- vpc str
- (Required String) The AWS VPC ID for the network.
- private
Link StringEndpoint Service - (Optional String) The AWS VPC endpoint service for the network (used for Private Link) if available.
- vpc String
- (Required String) The AWS VPC ID for the network.
GetNetworkAzure
- Private
Link Dictionary<string, string>Service Aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
- Private
Link map[string]stringService Aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
- private
Link Map<String,String>Service Aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
- private
Link {[key: string]: string}Service Aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
- private_
link_ Mapping[str, str]service_ aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
- private
Link Map<String>Service Aliases - (Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
GetNetworkEnvironment
- Id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- Id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- id String
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- id string
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- id str
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
- id String
- The ID of the Environment that the Network belongs to, for example,
env-xyz456.
GetNetworkGcp
- Project string
- (Required String) The GCP project.
- Vpc
Network string - (Required String) The GCP VPC network name.
- Project string
- (Required String) The GCP project.
- Vpc
Network string - (Required String) The GCP VPC network name.
- project String
- (Required String) The GCP project.
- vpc
Network String - (Required String) The GCP VPC network name.
- project string
- (Required String) The GCP project.
- vpc
Network string - (Required String) The GCP VPC network name.
- project str
- (Required String) The GCP project.
- vpc_
network str - (Required String) The GCP VPC network name.
- project String
- (Required String) The GCP project.
- vpc
Network String - (Required String) The GCP VPC network name.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluentTerraform Provider.
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
