Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. getNetwork
Viewing docs for redpanda 2.0.0
published on Wednesday, Jun 3, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

redpanda.getNetwork

Viewing docs for redpanda 2.0.0
published on Wednesday, Jun 3, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

    Data source for a Redpanda Cloud network

    Usage

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

const example = redpanda.getNetwork({
    id: "network_id",
});

    import pulumi
import pulumi_redpanda as redpanda

example = redpanda.get_network(id="network_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redpanda.LookupNetwork(ctx, &redpanda.LookupNetworkArgs{
			Id: "network_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;

return await Deployment.RunAsync(() => 
{
    var example = Redpanda.GetNetwork.Invoke(new()
    {
        Id = "network_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.RedpandaFunctions;
import com.pulumi.redpanda.inputs.GetNetworkArgs;
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 example = RedpandaFunctions.getNetwork(GetNetworkArgs.builder()
            .id("network_id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: redpanda:getNetwork
      arguments:
        id: network_id

    Example coming soon!

    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(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(id: pulumi.Input[Optional[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: redpanda:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary
    data "redpanda_getnetwork" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    UUID of the network
    Id string
    UUID of the network
    id string
    UUID of the network
    id String
    UUID of the network
    id string
    UUID of the network
    id str
    UUID of the network
    id String
    UUID of the network

    getNetwork Result

    The following output properties are available:

    CidrBlock string
    The cidr_block to create the network in
    CloudProvider string
    The cloud provider to create the network in. Can also be set at the provider level
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    CustomerManagedResources GetNetworkCustomerManagedResources
    Cloud resources created by user.
    Id string
    UUID of the network
    Name string
    Name of the network
    Region string
    The region to create the network in. Can also be set at the provider level
    ResourceGroupId string
    The ID of the resource group in which to create the network
    State string
    Current state of the network.
    Zones List<string>
    Network availability zones.
    CidrBlock string
    The cidr_block to create the network in
    CloudProvider string
    The cloud provider to create the network in. Can also be set at the provider level
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    CustomerManagedResources GetNetworkCustomerManagedResources
    Cloud resources created by user.
    Id string
    UUID of the network
    Name string
    Name of the network
    Region string
    The region to create the network in. Can also be set at the provider level
    ResourceGroupId string
    The ID of the resource group in which to create the network
    State string
    Current state of the network.
    Zones []string
    Network availability zones.
    cidr_block string
    The cidr_block to create the network in
    cloud_provider string
    The cloud provider to create the network in. Can also be set at the provider level
    cluster_type string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customer_managed_resources object
    Cloud resources created by user.
    id string
    UUID of the network
    name string
    Name of the network
    region string
    The region to create the network in. Can also be set at the provider level
    resource_group_id string
    The ID of the resource group in which to create the network
    state string
    Current state of the network.
    zones list(string)
    Network availability zones.
    cidrBlock String
    The cidr_block to create the network in
    cloudProvider String
    The cloud provider to create the network in. Can also be set at the provider level
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources GetNetworkCustomerManagedResources
    Cloud resources created by user.
    id String
    UUID of the network
    name String
    Name of the network
    region String
    The region to create the network in. Can also be set at the provider level
    resourceGroupId String
    The ID of the resource group in which to create the network
    state String
    Current state of the network.
    zones List<String>
    Network availability zones.
    cidrBlock string
    The cidr_block to create the network in
    cloudProvider string
    The cloud provider to create the network in. Can also be set at the provider level
    clusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources GetNetworkCustomerManagedResources
    Cloud resources created by user.
    id string
    UUID of the network
    name string
    Name of the network
    region string
    The region to create the network in. Can also be set at the provider level
    resourceGroupId string
    The ID of the resource group in which to create the network
    state string
    Current state of the network.
    zones string[]
    Network availability zones.
    cidr_block str
    The cidr_block to create the network in
    cloud_provider str
    The cloud provider to create the network in. Can also be set at the provider level
    cluster_type str
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customer_managed_resources GetNetworkCustomerManagedResources
    Cloud resources created by user.
    id str
    UUID of the network
    name str
    Name of the network
    region str
    The region to create the network in. Can also be set at the provider level
    resource_group_id str
    The ID of the resource group in which to create the network
    state str
    Current state of the network.
    zones Sequence[str]
    Network availability zones.
    cidrBlock String
    The cidr_block to create the network in
    cloudProvider String
    The cloud provider to create the network in. Can also be set at the provider level
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources Property Map
    Cloud resources created by user.
    id String
    UUID of the network
    name String
    Name of the network
    region String
    The region to create the network in. Can also be set at the provider level
    resourceGroupId String
    The ID of the resource group in which to create the network
    state String
    Current state of the network.
    zones List<String>
    Network availability zones.

    Supporting Types

    GetNetworkCustomerManagedResources

    Aws GetNetworkCustomerManagedResourcesAws
    The AWS resources managed by user.
    Gcp GetNetworkCustomerManagedResourcesGcp
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    Aws GetNetworkCustomerManagedResourcesAws
    The AWS resources managed by user.
    Gcp GetNetworkCustomerManagedResourcesGcp
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    aws object
    The AWS resources managed by user.
    gcp object
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    aws GetNetworkCustomerManagedResourcesAws
    The AWS resources managed by user.
    gcp GetNetworkCustomerManagedResourcesGcp
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    aws GetNetworkCustomerManagedResourcesAws
    The AWS resources managed by user.
    gcp GetNetworkCustomerManagedResourcesGcp
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    aws GetNetworkCustomerManagedResourcesAws
    The AWS resources managed by user.
    gcp GetNetworkCustomerManagedResourcesGcp
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.
    aws Property Map
    The AWS resources managed by user.
    gcp Property Map
    GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP for details.

    GetNetworkCustomerManagedResourcesAws

    dynamodb_table object
    AWS DynamoDB table specification.
    management_bucket object
    AWS storage bucket properties by ARN.
    private_subnets object
    AWS Subnets Specification
    vpc object
    AWS VPC Specification
    dynamodbTable Property Map
    AWS DynamoDB table specification.
    managementBucket Property Map
    AWS storage bucket properties by ARN.
    privateSubnets Property Map
    AWS Subnets Specification
    vpc Property Map
    AWS VPC Specification

    GetNetworkCustomerManagedResourcesAwsDynamodbTable

    Arn string
    AWS DynamoDB table identifier.
    Arn string
    AWS DynamoDB table identifier.
    arn string
    AWS DynamoDB table identifier.
    arn String
    AWS DynamoDB table identifier.
    arn string
    AWS DynamoDB table identifier.
    arn str
    AWS DynamoDB table identifier.
    arn String
    AWS DynamoDB table identifier.

    GetNetworkCustomerManagedResourcesAwsManagementBucket

    Arn string
    AWS storage bucket identifier.
    Arn string
    AWS storage bucket identifier.
    arn string
    AWS storage bucket identifier.
    arn String
    AWS storage bucket identifier.
    arn string
    AWS storage bucket identifier.
    arn str
    AWS storage bucket identifier.
    arn String
    AWS storage bucket identifier.

    GetNetworkCustomerManagedResourcesAwsPrivateSubnets

    Arns List<string>
    AWS private subnet identifiers
    Arns []string
    AWS private subnet identifiers
    arns list(string)
    AWS private subnet identifiers
    arns List<String>
    AWS private subnet identifiers
    arns string[]
    AWS private subnet identifiers
    arns Sequence[str]
    AWS private subnet identifiers
    arns List<String>
    AWS private subnet identifiers

    GetNetworkCustomerManagedResourcesAwsVpc

    Arn string
    AWS VPC identifier.
    Arn string
    AWS VPC identifier.
    arn string
    AWS VPC identifier.
    arn String
    AWS VPC identifier.
    arn string
    AWS VPC identifier.
    arn str
    AWS VPC identifier.
    arn String
    AWS VPC identifier.

    GetNetworkCustomerManagedResourcesGcp

    ManagementBucket GetNetworkCustomerManagedResourcesGcpManagementBucket
    GCP storage bucket properties.
    NetworkName string
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    NetworkProjectId string
    GCP project ID where the network is created.
    ManagementBucket GetNetworkCustomerManagedResourcesGcpManagementBucket
    GCP storage bucket properties.
    NetworkName string
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    NetworkProjectId string
    GCP project ID where the network is created.
    management_bucket object
    GCP storage bucket properties.
    network_name string
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    network_project_id string
    GCP project ID where the network is created.
    managementBucket GetNetworkCustomerManagedResourcesGcpManagementBucket
    GCP storage bucket properties.
    networkName String
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    networkProjectId String
    GCP project ID where the network is created.
    managementBucket GetNetworkCustomerManagedResourcesGcpManagementBucket
    GCP storage bucket properties.
    networkName string
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    networkProjectId string
    GCP project ID where the network is created.
    management_bucket GetNetworkCustomerManagedResourcesGcpManagementBucket
    GCP storage bucket properties.
    network_name str
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    network_project_id str
    GCP project ID where the network is created.
    managementBucket Property Map
    GCP storage bucket properties.
    networkName String
    Name of user-created network where the Redpanda cluster is deployed to. See the official GCP API reference.
    networkProjectId String
    GCP project ID where the network is created.

    GetNetworkCustomerManagedResourcesGcpManagementBucket

    Name string
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    Name string
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    name string
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    name String
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    name string
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    name str
    GCP storage bucket name for storing the state of Redpanda cluster deployment
    name String
    GCP storage bucket name for storing the state of Redpanda cluster deployment

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    Viewing docs for redpanda 2.0.0
    published on Wednesday, Jun 3, 2026 by redpanda-data
    Schema (JSON)
    redpanda-data/terraform-provider-redpanda

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial