Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Redpanda Provider
  3. API Docs
  4. Network
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

redpanda.Network

Explore with Pulumi AI

redpanda logo
redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
redpanda-data/terraform-provider-redpanda

    Creates a network in the Redpanda Cloud.

    Usage

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

const testResourceGroup = new redpanda.ResourceGroup("testResourceGroup", {});
const config = new pulumi.Config();
const region = config.get("region") || "us-east-1";
const cloudProvider = config.get("cloudProvider") || "aws";
const testNetwork = new redpanda.Network("testNetwork", {
    resourceGroupId: testResourceGroup.id,
    cloudProvider: cloudProvider,
    region: region,
    clusterType: "dedicated",
    cidrBlock: "10.0.0.0/20",
});
const resourceGroupName = config.get("resourceGroupName") || "testname";
const networkName = config.get("networkName") || "testname";

    import pulumi
import pulumi_redpanda as redpanda

test_resource_group = redpanda.ResourceGroup("testResourceGroup")
config = pulumi.Config()
region = config.get("region")
if region is None:
    region = "us-east-1"
cloud_provider = config.get("cloudProvider")
if cloud_provider is None:
    cloud_provider = "aws"
test_network = redpanda.Network("testNetwork",
    resource_group_id=test_resource_group.id,
    cloud_provider=cloud_provider,
    region=region,
    cluster_type="dedicated",
    cidr_block="10.0.0.0/20")
resource_group_name = config.get("resourceGroupName")
if resource_group_name is None:
    resource_group_name = "testname"
network_name = config.get("networkName")
if network_name is None:
    network_name = "testname"

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testResourceGroup, err := redpanda.NewResourceGroup(ctx, "testResourceGroup", nil)
		if err != nil {
			return err
		}
		cfg := config.New(ctx, "")
		region := "us-east-1"
		if param := cfg.Get("region"); param != "" {
			region = param
		}
		cloudProvider := "aws"
		if param := cfg.Get("cloudProvider"); param != "" {
			cloudProvider = param
		}
		_, err = redpanda.NewNetwork(ctx, "testNetwork", &redpanda.NetworkArgs{
			ResourceGroupId: testResourceGroup.ID(),
			CloudProvider:   pulumi.String(cloudProvider),
			Region:          pulumi.String(region),
			ClusterType:     pulumi.String("dedicated"),
			CidrBlock:       pulumi.String("10.0.0.0/20"),
		})
		if err != nil {
			return err
		}
		resourceGroupName := "testname"
		if param := cfg.Get("resourceGroupName"); param != "" {
			resourceGroupName = param
		}
		networkName := "testname"
		if param := cfg.Get("networkName"); param != "" {
			networkName = param
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testResourceGroup = new Redpanda.ResourceGroup("testResourceGroup");

    var config = new Config();
    var region = config.Get("region") ?? "us-east-1";
    var cloudProvider = config.Get("cloudProvider") ?? "aws";
    var testNetwork = new Redpanda.Network("testNetwork", new()
    {
        ResourceGroupId = testResourceGroup.Id,
        CloudProvider = cloudProvider,
        Region = region,
        ClusterType = "dedicated",
        CidrBlock = "10.0.0.0/20",
    });

    var resourceGroupName = config.Get("resourceGroupName") ?? "testname";
    var networkName = config.Get("networkName") ?? "testname";
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.ResourceGroup;
import com.pulumi.redpanda.Network;
import com.pulumi.redpanda.NetworkArgs;
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 config = ctx.config();
        var testResourceGroup = new ResourceGroup("testResourceGroup");

        final var region = config.get("region").orElse("us-east-1");
        final var cloudProvider = config.get("cloudProvider").orElse("aws");
        var testNetwork = new Network("testNetwork", NetworkArgs.builder()
            .resourceGroupId(testResourceGroup.id())
            .cloudProvider(cloudProvider)
            .region(region)
            .clusterType("dedicated")
            .cidrBlock("10.0.0.0/20")
            .build());

        final var resourceGroupName = config.get("resourceGroupName").orElse("testname");
        final var networkName = config.get("networkName").orElse("testname");
    }
}

    configuration:
  resourceGroupName:
    type: string
    default: testname
  networkName:
    type: string
    default: testname
  region:
    type: string
    default: us-east-1
  cloudProvider:
    type: string
    default: aws
resources:
  testResourceGroup:
    type: redpanda:ResourceGroup
  testNetwork:
    type: redpanda:Network
    properties:
      resourceGroupId: ${testResourceGroup.id}
      cloudProvider: ${cloudProvider}
      region: ${region}
      clusterType: dedicated
      cidrBlock: 10.0.0.0/20

    Create Network Resource

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

    Constructor syntax

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

@overload
def Network(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cloud_provider: Optional[str] = None,
            cluster_type: Optional[str] = None,
            region: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            cidr_block: Optional[str] = None,
            customer_managed_resources: Optional[NetworkCustomerManagedResourcesArgs] = None,
            name: Optional[str] = None)
    func NewNetwork(ctx *Context, name string, args NetworkArgs, opts ...ResourceOption) (*Network, error)
    public Network(string name, NetworkArgs args, CustomResourceOptions? opts = null)
    public Network(String name, NetworkArgs args)
public Network(String name, NetworkArgs args, CustomResourceOptions options)

    type: redpanda:Network
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 NetworkArgs
    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 NetworkArgs
    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 NetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkArgs
    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 networkResource = new Redpanda.Network("networkResource", new()
{
    CloudProvider = "string",
    ClusterType = "string",
    Region = "string",
    ResourceGroupId = "string",
    CidrBlock = "string",
    CustomerManagedResources = new Redpanda.Inputs.NetworkCustomerManagedResourcesArgs
    {
        Aws = new Redpanda.Inputs.NetworkCustomerManagedResourcesAwsArgs
        {
            DynamodbTable = new Redpanda.Inputs.NetworkCustomerManagedResourcesAwsDynamodbTableArgs
            {
                Arn = "string",
            },
            ManagementBucket = new Redpanda.Inputs.NetworkCustomerManagedResourcesAwsManagementBucketArgs
            {
                Arn = "string",
            },
            PrivateSubnets = new Redpanda.Inputs.NetworkCustomerManagedResourcesAwsPrivateSubnetsArgs
            {
                Arns = new[]
                {
                    "string",
                },
            },
            Vpc = new Redpanda.Inputs.NetworkCustomerManagedResourcesAwsVpcArgs
            {
                Arn = "string",
            },
        },
    },
    Name = "string",
});

    example, err := redpanda.NewNetwork(ctx, "networkResource", &redpanda.NetworkArgs{
CloudProvider: pulumi.String("string"),
ClusterType: pulumi.String("string"),
Region: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
CidrBlock: pulumi.String("string"),
CustomerManagedResources: &.NetworkCustomerManagedResourcesArgs{
Aws: &.NetworkCustomerManagedResourcesAwsArgs{
DynamodbTable: &.NetworkCustomerManagedResourcesAwsDynamodbTableArgs{
Arn: pulumi.String("string"),
},
ManagementBucket: &.NetworkCustomerManagedResourcesAwsManagementBucketArgs{
Arn: pulumi.String("string"),
},
PrivateSubnets: &.NetworkCustomerManagedResourcesAwsPrivateSubnetsArgs{
Arns: pulumi.StringArray{
pulumi.String("string"),
},
},
Vpc: &.NetworkCustomerManagedResourcesAwsVpcArgs{
Arn: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
})

    var networkResource = new Network("networkResource", NetworkArgs.builder()
    .cloudProvider("string")
    .clusterType("string")
    .region("string")
    .resourceGroupId("string")
    .cidrBlock("string")
    .customerManagedResources(NetworkCustomerManagedResourcesArgs.builder()
        .aws(NetworkCustomerManagedResourcesAwsArgs.builder()
            .dynamodbTable(NetworkCustomerManagedResourcesAwsDynamodbTableArgs.builder()
                .arn("string")
                .build())
            .managementBucket(NetworkCustomerManagedResourcesAwsManagementBucketArgs.builder()
                .arn("string")
                .build())
            .privateSubnets(NetworkCustomerManagedResourcesAwsPrivateSubnetsArgs.builder()
                .arns("string")
                .build())
            .vpc(NetworkCustomerManagedResourcesAwsVpcArgs.builder()
                .arn("string")
                .build())
            .build())
        .build())
    .name("string")
    .build());

    network_resource = redpanda.Network("networkResource",
    cloud_provider="string",
    cluster_type="string",
    region="string",
    resource_group_id="string",
    cidr_block="string",
    customer_managed_resources={
        "aws": {
            "dynamodb_table": {
                "arn": "string",
            },
            "management_bucket": {
                "arn": "string",
            },
            "private_subnets": {
                "arns": ["string"],
            },
            "vpc": {
                "arn": "string",
            },
        },
    },
    name="string")

    const networkResource = new redpanda.Network("networkResource", {
    cloudProvider: "string",
    clusterType: "string",
    region: "string",
    resourceGroupId: "string",
    cidrBlock: "string",
    customerManagedResources: {
        aws: {
            dynamodbTable: {
                arn: "string",
            },
            managementBucket: {
                arn: "string",
            },
            privateSubnets: {
                arns: ["string"],
            },
            vpc: {
                arn: "string",
            },
        },
    },
    name: "string",
});

    type: redpanda:Network
properties:
    cidrBlock: string
    cloudProvider: string
    clusterType: string
    customerManagedResources:
        aws:
            dynamodbTable:
                arn: string
            managementBucket:
                arn: string
            privateSubnets:
                arns:
                    - string
            vpc:
                arn: string
    name: string
    region: string
    resourceGroupId: string

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

    CloudProvider string
    The cloud provider to create the network in.
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    Region string
    The region to create the network in.
    ResourceGroupId string
    The ID of the resource group in which to create the network
    CidrBlock string
    The cidr_block to create the network in
    CustomerManagedResources NetworkCustomerManagedResources
    Name string
    Name of the network
    CloudProvider string
    The cloud provider to create the network in.
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    Region string
    The region to create the network in.
    ResourceGroupId string
    The ID of the resource group in which to create the network
    CidrBlock string
    The cidr_block to create the network in
    CustomerManagedResources NetworkCustomerManagedResourcesArgs
    Name string
    Name of the network
    cloudProvider String
    The cloud provider to create the network in.
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    region String
    The region to create the network in.
    resourceGroupId String
    The ID of the resource group in which to create the network
    cidrBlock String
    The cidr_block to create the network in
    customerManagedResources NetworkCustomerManagedResources
    name String
    Name of the network
    cloudProvider string
    The cloud provider to create the network in.
    clusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    region string
    The region to create the network in.
    resourceGroupId string
    The ID of the resource group in which to create the network
    cidrBlock string
    The cidr_block to create the network in
    customerManagedResources NetworkCustomerManagedResources
    name string
    Name of the network
    cloud_provider str
    The cloud provider to create the network in.
    cluster_type str
    The type of cluster this network is associated with, can be one of dedicated or cloud
    region str
    The region to create the network in.
    resource_group_id str
    The ID of the resource group in which to create the network
    cidr_block str
    The cidr_block to create the network in
    customer_managed_resources NetworkCustomerManagedResourcesArgs
    name str
    Name of the network
    cloudProvider String
    The cloud provider to create the network in.
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    region String
    The region to create the network in.
    resourceGroupId String
    The ID of the resource group in which to create the network
    cidrBlock String
    The cidr_block to create the network in
    customerManagedResources Property Map
    name String
    Name of the network

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Network Resource

    Get an existing Network 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?: NetworkState, opts?: CustomResourceOptions): Network
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr_block: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        cluster_type: Optional[str] = None,
        customer_managed_resources: Optional[NetworkCustomerManagedResourcesArgs] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        resource_group_id: Optional[str] = None) -> Network
    func GetNetwork(ctx *Context, name string, id IDInput, state *NetworkState, opts ...ResourceOption) (*Network, error)
    public static Network Get(string name, Input<string> id, NetworkState? state, CustomResourceOptions? opts = null)
    public static Network get(String name, Output<String> id, NetworkState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:Network    get:      id: ${id}
    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.
    The following state arguments are supported:
    CidrBlock string
    The cidr_block to create the network in
    CloudProvider string
    The cloud provider to create the network in.
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    CustomerManagedResources NetworkCustomerManagedResources
    Name string
    Name of the network
    Region string
    The region to create the network in.
    ResourceGroupId string
    The ID of the resource group in which to create the network
    CidrBlock string
    The cidr_block to create the network in
    CloudProvider string
    The cloud provider to create the network in.
    ClusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    CustomerManagedResources NetworkCustomerManagedResourcesArgs
    Name string
    Name of the network
    Region string
    The region to create the network in.
    ResourceGroupId string
    The ID of the resource group in which to create the network
    cidrBlock String
    The cidr_block to create the network in
    cloudProvider String
    The cloud provider to create the network in.
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources NetworkCustomerManagedResources
    name String
    Name of the network
    region String
    The region to create the network in.
    resourceGroupId String
    The ID of the resource group in which to create the network
    cidrBlock string
    The cidr_block to create the network in
    cloudProvider string
    The cloud provider to create the network in.
    clusterType string
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources NetworkCustomerManagedResources
    name string
    Name of the network
    region string
    The region to create the network in.
    resourceGroupId string
    The ID of the resource group in which to create the network
    cidr_block str
    The cidr_block to create the network in
    cloud_provider str
    The cloud provider to create the network in.
    cluster_type str
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customer_managed_resources NetworkCustomerManagedResourcesArgs
    name str
    Name of the network
    region str
    The region to create the network in.
    resource_group_id str
    The ID of the resource group in which to create the network
    cidrBlock String
    The cidr_block to create the network in
    cloudProvider String
    The cloud provider to create the network in.
    clusterType String
    The type of cluster this network is associated with, can be one of dedicated or cloud
    customerManagedResources Property Map
    name String
    Name of the network
    region String
    The region to create the network in.
    resourceGroupId String
    The ID of the resource group in which to create the network

    Supporting Types

    NetworkCustomerManagedResources, NetworkCustomerManagedResourcesArgs

    NetworkCustomerManagedResourcesAws, NetworkCustomerManagedResourcesAwsArgs

    NetworkCustomerManagedResourcesAwsDynamodbTable, NetworkCustomerManagedResourcesAwsDynamodbTableArgs

    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

    NetworkCustomerManagedResourcesAwsManagementBucket, NetworkCustomerManagedResourcesAwsManagementBucketArgs

    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

    NetworkCustomerManagedResourcesAwsPrivateSubnets, NetworkCustomerManagedResourcesAwsPrivateSubnetsArgs

    Arns List<string>
    AWS private subnet identifiers
    Arns []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

    NetworkCustomerManagedResourcesAwsVpc, NetworkCustomerManagedResourcesAwsVpcArgs

    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

    Import

    $ pulumi import redpanda:index/network:Network example networkId

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

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 0.13.0 published on Monday, Mar 17, 2025 by redpanda-data
    redpanda-data/terraform-provider-redpanda