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

confluentcloud.getNetwork

Explore with Pulumi AI

Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

Example Usage

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

export = async () => {
    const exampleUsingId = await confluentcloud.getNetwork({
        id: "n-abc123",
        environment: {
            id: "env-xyz456",
        },
    });
    const test_sa = new confluentcloud.ServiceAccount("test-sa", {
        displayName: "test_sa",
        description: `test_sa for ${exampleUsingId.displayName}`,
    });
    const exampleUsingName = await confluentcloud.getNetwork({
        displayName: "my_network",
        environment: {
            id: "env-xyz456",
        },
    });
    return {
        exampleUsingName: exampleUsingName,
    };
}
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

example_using_id = confluentcloud.get_network(id="n-abc123",
    environment={
        "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 = confluentcloud.get_network(display_name="my_network",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingName", example_using_name)
Copy
package main

import (
	"fmt"

	"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 {
		exampleUsingId, err := confluentcloud.LookupNetwork(ctx, &confluentcloud.LookupNetworkArgs{
			Id: pulumi.StringRef("n-abc123"),
			Environment: confluentcloud.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.Sprintf("test_sa for %v", exampleUsingId.DisplayName),
		})
		if err != nil {
			return err
		}
		exampleUsingName, err := confluentcloud.LookupNetwork(ctx, &confluentcloud.LookupNetworkArgs{
			DisplayName: pulumi.StringRef("my_network"),
			Environment: confluentcloud.GetNetworkEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingName)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var exampleUsingId = ConfluentCloud.GetNetwork.Invoke(new()
    {
        Id = "n-abc123",
        Environment = new ConfluentCloud.Inputs.GetNetworkEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    var test_sa = new ConfluentCloud.ServiceAccount("test-sa", new()
    {
        DisplayName = "test_sa",
        Description = $"test_sa for {exampleUsingId.Apply(getNetworkResult => getNetworkResult.DisplayName)}",
    });

    var exampleUsingName = ConfluentCloud.GetNetwork.Invoke(new()
    {
        DisplayName = "my_network",
        Environment = new ConfluentCloud.Inputs.GetNetworkEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    return new Dictionary<string, object?>
    {
        ["exampleUsingName"] = exampleUsingName,
    };
});
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.GetNetworkArgs;
import com.pulumi.confluentcloud.inputs.GetNetworkEnvironmentArgs;
import com.pulumi.confluentcloud.ServiceAccount;
import com.pulumi.confluentcloud.ServiceAccountArgs;
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 exampleUsingId = 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.displayName()))
            .build());

        final var exampleUsingName = ConfluentcloudFunctions.getNetwork(GetNetworkArgs.builder()
            .displayName("my_network")
            .environment(GetNetworkEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingName);
    }
}
Copy
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
  exampleUsingName:
    fn::invoke:
      function: confluentcloud:getNetwork
      arguments:
        displayName: my_network
        environment:
          id: env-xyz456
outputs:
  exampleUsingName: ${exampleUsingName}
Copy

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>
Copy
def get_network(aws: Optional[Sequence[GetNetworkAw]] = None,
                azures: Optional[Sequence[GetNetworkAzure]] = None,
                display_name: Optional[str] = None,
                dns_configs: Optional[Sequence[GetNetworkDnsConfig]] = 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,
                dns_configs: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkDnsConfigArgs]]]] = 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]
Copy
func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: confluentcloud:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Environment This property is required. Pulumi.ConfluentCloud.Inputs.GetNetworkEnvironment
Aws List<Pulumi.ConfluentCloud.Inputs.GetNetworkAw>
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
Azures List<Pulumi.ConfluentCloud.Inputs.GetNetworkAzure>
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
DisplayName string
A human-readable name for the Network.
DnsConfigs List<Pulumi.ConfluentCloud.Inputs.GetNetworkDnsConfig>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
Gcps List<Pulumi.ConfluentCloud.Inputs.GetNetworkGcp>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
Id string
The ID of the Network, for example, n-abc123.
Environment This property is required. GetNetworkEnvironment
Aws []GetNetworkAw
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
Azures []GetNetworkAzure
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
DisplayName string
A human-readable name for the Network.
DnsConfigs []GetNetworkDnsConfig
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
Gcps []GetNetworkGcp
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
Id string
The ID of the Network, for example, n-abc123.
environment This property is required. GetNetworkEnvironment
aws List<GetNetworkAw>
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures List<GetNetworkAzure>
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
displayName String
A human-readable name for the Network.
dnsConfigs List<GetNetworkDnsConfig>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
gcps List<GetNetworkGcp>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id String
The ID of the Network, for example, n-abc123.
environment This property is required. GetNetworkEnvironment
aws GetNetworkAw[]
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures GetNetworkAzure[]
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
displayName string
A human-readable name for the Network.
dnsConfigs GetNetworkDnsConfig[]
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
gcps GetNetworkGcp[]
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id string
The ID of the Network, for example, n-abc123.
environment This property is required. GetNetworkEnvironment
aws Sequence[GetNetworkAw]
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures Sequence[GetNetworkAzure]
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
display_name str
A human-readable name for the Network.
dns_configs Sequence[GetNetworkDnsConfig]
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
gcps Sequence[GetNetworkGcp]
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id str
The ID of the Network, for example, n-abc123.
environment This property is required. 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:
displayName String
A human-readable name for the Network.
dnsConfigs List<Property Map>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
gcps List<Property Map>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id String
The ID of the Network, for example, n-abc123.

getNetwork Result

The following output properties are available:

Aws List<Pulumi.ConfluentCloud.Outputs.GetNetworkAw>
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
Azures List<Pulumi.ConfluentCloud.Outputs.GetNetworkAzure>
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
Cidr string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. 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, and GCP.
ConnectionTypes List<string>
(Required List of String) The list of connection types that may be used with the network. Accepted connection types are: PEERING, TRANSITGATEWAY, and PRIVATELINK.
DisplayName string
(Required String) The name of the Network.
DnsConfigs List<Pulumi.ConfluentCloud.Outputs.GetNetworkDnsConfig>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
DnsDomain string
EndpointSuffix string
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
Environment Pulumi.ConfluentCloud.Outputs.GetNetworkEnvironment
Gateways List<Pulumi.ConfluentCloud.Outputs.GetNetworkGateway>
(Optional Configuration Block) supports the following:
Gcps List<Pulumi.ConfluentCloud.Outputs.GetNetworkGcp>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
Id string
(Optional String) The ID of the Gateway, for example, gw-abc123.
Region string
(Required String) The cloud provider region where the network exists.
ReservedCidr string
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
ResourceName string
(Required String) The Confluent Resource Name of the Network.
ZonalSubdomains Dictionary<string, string>
ZoneInfos List<Pulumi.ConfluentCloud.Outputs.GetNetworkZoneInfo>
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
Zones List<string>
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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 []GetNetworkAw
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
Azures []GetNetworkAzure
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
Cidr string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. 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, and GCP.
ConnectionTypes []string
(Required List of String) The list of connection types that may be used with the network. Accepted connection types are: PEERING, TRANSITGATEWAY, and PRIVATELINK.
DisplayName string
(Required String) The name of the Network.
DnsConfigs []GetNetworkDnsConfig
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
DnsDomain string
EndpointSuffix string
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
Environment GetNetworkEnvironment
Gateways []GetNetworkGateway
(Optional Configuration Block) supports the following:
Gcps []GetNetworkGcp
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
Id string
(Optional String) The ID of the Gateway, for example, gw-abc123.
Region string
(Required String) The cloud provider region where the network exists.
ReservedCidr string
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
ResourceName string
(Required String) The Confluent Resource Name of the Network.
ZonalSubdomains map[string]string
ZoneInfos []GetNetworkZoneInfo
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
Zones []string
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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<GetNetworkAw>
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures List<GetNetworkAzure>
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
cidr String
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. 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, and GCP.
connectionTypes List<String>
(Required List of String) The list of connection types that may be used with the network. Accepted connection types are: PEERING, TRANSITGATEWAY, and PRIVATELINK.
displayName String
(Required String) The name of the Network.
dnsConfigs List<GetNetworkDnsConfig>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
dnsDomain String
endpointSuffix String
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
environment GetNetworkEnvironment
gateways List<GetNetworkGateway>
(Optional Configuration Block) supports the following:
gcps List<GetNetworkGcp>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id String
(Optional String) The ID of the Gateway, for example, gw-abc123.
region String
(Required String) The cloud provider region where the network exists.
reservedCidr String
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
resourceName String
(Required String) The Confluent Resource Name of the Network.
zonalSubdomains Map<String,String>
zoneInfos List<GetNetworkZoneInfo>
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
zones List<String>
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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 GetNetworkAw[]
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures GetNetworkAzure[]
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
cidr string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. 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, and GCP.
connectionTypes string[]
(Required List of String) The list of connection types that may be used with the network. Accepted connection types are: PEERING, TRANSITGATEWAY, and PRIVATELINK.
displayName string
(Required String) The name of the Network.
dnsConfigs GetNetworkDnsConfig[]
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
dnsDomain string
endpointSuffix string
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
environment GetNetworkEnvironment
gateways GetNetworkGateway[]
(Optional Configuration Block) supports the following:
gcps GetNetworkGcp[]
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id string
(Optional String) The ID of the Gateway, for example, gw-abc123.
region string
(Required String) The cloud provider region where the network exists.
reservedCidr string
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
resourceName string
(Required String) The Confluent Resource Name of the Network.
zonalSubdomains {[key: string]: string}
zoneInfos GetNetworkZoneInfo[]
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
zones string[]
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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[GetNetworkAw]
(Optional Configuration Block) The AWS-specific network details if available. It supports the following:
azures Sequence[GetNetworkAzure]
(Optional Configuration Block) The Azure-specific network details if available. It supports the following:
cidr str
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. 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, and GCP.
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, and PRIVATELINK.
display_name str
(Required String) The name of the Network.
dns_configs Sequence[GetNetworkDnsConfig]
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
dns_domain str
endpoint_suffix str
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
environment GetNetworkEnvironment
gateways Sequence[GetNetworkGateway]
(Optional Configuration Block) supports the following:
gcps Sequence[GetNetworkGcp]
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id str
(Optional String) The ID of the Gateway, for example, gw-abc123.
region str
(Required String) The cloud provider region where the network exists.
reserved_cidr str
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
resource_name str
(Required String) The Confluent Resource Name of the Network.
zonal_subdomains Mapping[str, str]
zone_infos Sequence[GetNetworkZoneInfo]
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
zones Sequence[str]
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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 be used for the network. Must be /27. 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, and GCP.
connectionTypes List<String>
(Required List of String) The list of connection types that may be used with the network. Accepted connection types are: PEERING, TRANSITGATEWAY, and PRIVATELINK.
displayName String
(Required String) The name of the Network.
dnsConfigs List<Property Map>
(Optional Configuration Block) Network DNS config. It applies only to the PRIVATELINK network connection type. It supports the following:
dnsDomain String
endpointSuffix String
(Optional String) The endpoint suffix for the network, if applicable. It can take various forms (for example, .pr1jy6.us-east-2.aws.confluent.cloud or -pr1jy6.us-east-2.aws.confluent.cloud). Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding flink — that is, https://flink + endpoint_suffix; namely, https://flink.pr1jy6.us-east-2.aws.confluent.cloud.
environment Property Map
gateways List<Property Map>
(Optional Configuration Block) supports the following:
gcps List<Property Map>
(Optional Configuration Block) The GCP-specific network details if available. It supports the following:
id String
(Optional String) The ID of the Gateway, for example, gw-abc123.
region String
(Required String) The cloud provider region where the network exists.
reservedCidr String
(Required String) The reserved IPv4 CIDR block to be used for the network. Must be /24. If not specified, Confluent Cloud Network uses 172.20.255.0/24.
resourceName String
(Required String) The Confluent Resource Name of the Network.
zonalSubdomains Map<String>
zoneInfos List<Property Map>
(Required Configuration Blocks) Each item represents information related to a single zone. It supports the following:
zones List<String>
(Optional List of String) The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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

Account This property is required. string
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
PrivateLinkEndpointService This property is required. string
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
Vpc This property is required. string
(Required String) The Confluent Cloud VPC ID.
Account This property is required. string
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
PrivateLinkEndpointService This property is required. string
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
Vpc This property is required. string
(Required String) The Confluent Cloud VPC ID.
account This property is required. String
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
privateLinkEndpointService This property is required. String
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
vpc This property is required. String
(Required String) The Confluent Cloud VPC ID.
account This property is required. string
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
privateLinkEndpointService This property is required. string
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
vpc This property is required. string
(Required String) The Confluent Cloud VPC ID.
account This property is required. str
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
private_link_endpoint_service This property is required. str
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
vpc This property is required. str
(Required String) The Confluent Cloud VPC ID.
account This property is required. String
(Required String) The AWS account ID associated with the Confluent Cloud VPC.
privateLinkEndpointService This property is required. String
(Optional String) The endpoint service of the Confluent Cloud VPC (used for PrivateLink) if available.
vpc This property is required. String
(Required String) The Confluent Cloud VPC ID.

GetNetworkAzure

PrivateLinkServiceAliases This property is required. Dictionary<string, string>
(Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
PrivateLinkServiceAliases This property is required. map[string]string
(Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
privateLinkServiceAliases This property is required. Map<String,String>
(Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
privateLinkServiceAliases This property is required. {[key: string]: string}
(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_service_aliases This property is required. Mapping[str, str]
(Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.
privateLinkServiceAliases This property is required. Map<String>
(Optional Map) The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are Azure Private Link Service Aliases.

GetNetworkDnsConfig

Resolution This property is required. string
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.
Resolution This property is required. string
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.
resolution This property is required. String
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.
resolution This property is required. string
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.
resolution This property is required. str
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.
resolution This property is required. String
(Required String) Network DNS resolution. When resolution is CHASED_PRIVATE, clusters in this network require both public and private DNS to resolve cluster endpoints. When resolution is PRIVATE, clusters in this network only require private DNS to resolve cluster endpoints.

GetNetworkEnvironment

Id This property is required. string

The ID of the Environment that the Network belongs to, for example, env-xyz456.

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 belongs to, for example, env-xyz456.

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 belongs to, for example, env-xyz456.

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 belongs to, for example, env-xyz456.

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 belongs to, for example, env-xyz456.

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 belongs to, for example, env-xyz456.

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

GetNetworkGateway

Id This property is required. string
The ID of the Network, for example, n-abc123.
Id This property is required. string
The ID of the Network, for example, n-abc123.
id This property is required. String
The ID of the Network, for example, n-abc123.
id This property is required. string
The ID of the Network, for example, n-abc123.
id This property is required. str
The ID of the Network, for example, n-abc123.
id This property is required. String
The ID of the Network, for example, n-abc123.

GetNetworkGcp

PrivateServiceConnectServiceAttachments This property is required. Dictionary<string, string>
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
Project This property is required. string
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
VpcNetwork This property is required. string
(Required String) The network name of the Confluent Cloud VPC.
PrivateServiceConnectServiceAttachments This property is required. map[string]string
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
Project This property is required. string
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
VpcNetwork This property is required. string
(Required String) The network name of the Confluent Cloud VPC.
privateServiceConnectServiceAttachments This property is required. Map<String,String>
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
project This property is required. String
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
vpcNetwork This property is required. String
(Required String) The network name of the Confluent Cloud VPC.
privateServiceConnectServiceAttachments This property is required. {[key: string]: string}
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
project This property is required. string
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
vpcNetwork This property is required. string
(Required String) The network name of the Confluent Cloud VPC.
private_service_connect_service_attachments This property is required. Mapping[str, str]
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
project This property is required. str
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
vpc_network This property is required. str
(Required String) The network name of the Confluent Cloud VPC.
privateServiceConnectServiceAttachments This property is required. Map<String>
(Optional Map) The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are GCP Private Service Connect service attachment.
project This property is required. String
(Required String) The GCP Project ID associated with the Confluent Cloud VPC.
vpcNetwork This property is required. String
(Required String) The network name of the Confluent Cloud VPC.

GetNetworkZoneInfo

Cidr This property is required. string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
ZoneId This property is required. string
(Required String) Cloud provider zone ID.
Cidr This property is required. string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
ZoneId This property is required. string
(Required String) Cloud provider zone ID.
cidr This property is required. String
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
zoneId This property is required. String
(Required String) Cloud provider zone ID.
cidr This property is required. string
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
zoneId This property is required. string
(Required String) Cloud provider zone ID.
cidr This property is required. str
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
zone_id This property is required. str
(Required String) Cloud provider zone ID.
cidr This property is required. String
(Required String) The IPv4 CIDR block to be used for the network. Must be /27. Required for VPC peering and AWS TransitGateway.
zoneId This property is required. String
(Required String) Cloud provider zone ID.

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.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud