1. Packages
  2. Confluent Provider
  3. API Docs
  4. Peering
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi

confluentcloud.Peering

Explore with Pulumi AI

Example Usage

Example Peering on AWS

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const aws_peering = new confluentcloud.Network("aws-peering", {
    displayName: "AWS Peering Network",
    cloud: "AWS",
    region: "us-east-2",
    cidr: "10.10.0.0/16",
    connectionTypes: ["PEERING"],
    environment: {
        id: development.id,
    },
});
const aws = new confluentcloud.Peering("aws", {
    displayName: "AWS Peering",
    aws: {
        account: "012345678901",
        vpc: "vpc-abcdef0123456789a",
        routes: ["172.31.0.0/16"],
        customerRegion: "us-east-2",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: aws_peering.id,
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
aws_peering = confluentcloud.Network("aws-peering",
    display_name="AWS Peering Network",
    cloud="AWS",
    region="us-east-2",
    cidr="10.10.0.0/16",
    connection_types=["PEERING"],
    environment={
        "id": development.id,
    })
aws = confluentcloud.Peering("aws",
    display_name="AWS Peering",
    aws={
        "account": "012345678901",
        "vpc": "vpc-abcdef0123456789a",
        "routes": ["172.31.0.0/16"],
        "customer_region": "us-east-2",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": aws_peering.id,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		aws_peering, err := confluentcloud.NewNetwork(ctx, "aws-peering", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("AWS Peering Network"),
			Cloud:       pulumi.String("AWS"),
			Region:      pulumi.String("us-east-2"),
			Cidr:        pulumi.String("10.10.0.0/16"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PEERING"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPeering(ctx, "aws", &confluentcloud.PeeringArgs{
			DisplayName: pulumi.String("AWS Peering"),
			Aws: &confluentcloud.PeeringAwsArgs{
				Account: pulumi.String("012345678901"),
				Vpc:     pulumi.String("vpc-abcdef0123456789a"),
				Routes: pulumi.StringArray{
					pulumi.String("172.31.0.0/16"),
				},
				CustomerRegion: pulumi.String("us-east-2"),
			},
			Environment: &confluentcloud.PeeringEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PeeringNetworkArgs{
				Id: aws_peering.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var aws_peering = new ConfluentCloud.Network("aws-peering", new()
    {
        DisplayName = "AWS Peering Network",
        Cloud = "AWS",
        Region = "us-east-2",
        Cidr = "10.10.0.0/16",
        ConnectionTypes = new[]
        {
            "PEERING",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var aws = new ConfluentCloud.Peering("aws", new()
    {
        DisplayName = "AWS Peering",
        Aws = new ConfluentCloud.Inputs.PeeringAwsArgs
        {
            Account = "012345678901",
            Vpc = "vpc-abcdef0123456789a",
            Routes = new[]
            {
                "172.31.0.0/16",
            },
            CustomerRegion = "us-east-2",
        },
        Environment = new ConfluentCloud.Inputs.PeeringEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PeeringNetworkArgs
        {
            Id = aws_peering.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.Peering;
import com.pulumi.confluentcloud.PeeringArgs;
import com.pulumi.confluentcloud.inputs.PeeringAwsArgs;
import com.pulumi.confluentcloud.inputs.PeeringEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PeeringNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var aws_peering = new Network("aws-peering", NetworkArgs.builder()
            .displayName("AWS Peering Network")
            .cloud("AWS")
            .region("us-east-2")
            .cidr("10.10.0.0/16")
            .connectionTypes("PEERING")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var aws = new Peering("aws", PeeringArgs.builder()
            .displayName("AWS Peering")
            .aws(PeeringAwsArgs.builder()
                .account("012345678901")
                .vpc("vpc-abcdef0123456789a")
                .routes("172.31.0.0/16")
                .customerRegion("us-east-2")
                .build())
            .environment(PeeringEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PeeringNetworkArgs.builder()
                .id(aws_peering.id())
                .build())
            .build());

    }
}
Copy
resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  aws-peering:
    type: confluentcloud:Network
    properties:
      displayName: AWS Peering Network
      cloud: AWS
      region: us-east-2
      cidr: 10.10.0.0/16
      connectionTypes:
        - PEERING
      environment:
        id: ${development.id}
  aws:
    type: confluentcloud:Peering
    properties:
      displayName: AWS Peering
      aws:
        account: '012345678901'
        vpc: vpc-abcdef0123456789a
        routes:
          - 172.31.0.0/16
        customerRegion: us-east-2
      environment:
        id: ${development.id}
      network:
        id: ${["aws-peering"].id}
Copy

Example Peering on Azure

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const azure_peering = new confluentcloud.Network("azure-peering", {
    displayName: "Azure Peering Network",
    cloud: "AZURE",
    region: "centralus",
    cidr: "10.10.0.0/16",
    connectionTypes: ["PEERING"],
    environment: {
        id: development.id,
    },
});
const azure = new confluentcloud.Peering("azure", {
    displayName: "Azure Peering",
    azure: {
        tenant: "1111tttt-1111-1111-1111-111111tttttt",
        vnet: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet",
        customerRegion: "centralus",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: azure_peering.id,
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
azure_peering = confluentcloud.Network("azure-peering",
    display_name="Azure Peering Network",
    cloud="AZURE",
    region="centralus",
    cidr="10.10.0.0/16",
    connection_types=["PEERING"],
    environment={
        "id": development.id,
    })
azure = confluentcloud.Peering("azure",
    display_name="Azure Peering",
    azure={
        "tenant": "1111tttt-1111-1111-1111-111111tttttt",
        "vnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet",
        "customer_region": "centralus",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": azure_peering.id,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		azure_peering, err := confluentcloud.NewNetwork(ctx, "azure-peering", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("Azure Peering Network"),
			Cloud:       pulumi.String("AZURE"),
			Region:      pulumi.String("centralus"),
			Cidr:        pulumi.String("10.10.0.0/16"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PEERING"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPeering(ctx, "azure", &confluentcloud.PeeringArgs{
			DisplayName: pulumi.String("Azure Peering"),
			Azure: &confluentcloud.PeeringAzureArgs{
				Tenant:         pulumi.String("1111tttt-1111-1111-1111-111111tttttt"),
				Vnet:           pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet"),
				CustomerRegion: pulumi.String("centralus"),
			},
			Environment: &confluentcloud.PeeringEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PeeringNetworkArgs{
				Id: azure_peering.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var azure_peering = new ConfluentCloud.Network("azure-peering", new()
    {
        DisplayName = "Azure Peering Network",
        Cloud = "AZURE",
        Region = "centralus",
        Cidr = "10.10.0.0/16",
        ConnectionTypes = new[]
        {
            "PEERING",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var azure = new ConfluentCloud.Peering("azure", new()
    {
        DisplayName = "Azure Peering",
        Azure = new ConfluentCloud.Inputs.PeeringAzureArgs
        {
            Tenant = "1111tttt-1111-1111-1111-111111tttttt",
            Vnet = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet",
            CustomerRegion = "centralus",
        },
        Environment = new ConfluentCloud.Inputs.PeeringEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PeeringNetworkArgs
        {
            Id = azure_peering.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.Peering;
import com.pulumi.confluentcloud.PeeringArgs;
import com.pulumi.confluentcloud.inputs.PeeringAzureArgs;
import com.pulumi.confluentcloud.inputs.PeeringEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PeeringNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var azure_peering = new Network("azure-peering", NetworkArgs.builder()
            .displayName("Azure Peering Network")
            .cloud("AZURE")
            .region("centralus")
            .cidr("10.10.0.0/16")
            .connectionTypes("PEERING")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var azure = new Peering("azure", PeeringArgs.builder()
            .displayName("Azure Peering")
            .azure(PeeringAzureArgs.builder()
                .tenant("1111tttt-1111-1111-1111-111111tttttt")
                .vnet("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet")
                .customerRegion("centralus")
                .build())
            .environment(PeeringEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PeeringNetworkArgs.builder()
                .id(azure_peering.id())
                .build())
            .build());

    }
}
Copy
resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  azure-peering:
    type: confluentcloud:Network
    properties:
      displayName: Azure Peering Network
      cloud: AZURE
      region: centralus
      cidr: 10.10.0.0/16
      connectionTypes:
        - PEERING
      environment:
        id: ${development.id}
  azure:
    type: confluentcloud:Peering
    properties:
      displayName: Azure Peering
      azure:
        tenant: 1111tttt-1111-1111-1111-111111tttttt
        vnet: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet
        customerRegion: centralus
      environment:
        id: ${development.id}
      network:
        id: ${["azure-peering"].id}
Copy

Example Peering on GCP

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

const development = new confluentcloud.Environment("development", {displayName: "Development"});
const gcp_peering = new confluentcloud.Network("gcp-peering", {
    displayName: "GCP Peering Network",
    cloud: "GCP",
    region: "us-west4",
    cidr: "10.10.0.0/16",
    connectionTypes: ["PEERING"],
    environment: {
        id: development.id,
    },
});
const gcp = new confluentcloud.Peering("gcp", {
    displayName: "GCP Peering",
    gcp: {
        project: "temp-gear-123456",
        vpcNetwork: "customer-test-vpc-network",
    },
    environment: {
        id: development.id,
    },
    network: {
        id: gcp_peering.id,
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

development = confluentcloud.Environment("development", display_name="Development")
gcp_peering = confluentcloud.Network("gcp-peering",
    display_name="GCP Peering Network",
    cloud="GCP",
    region="us-west4",
    cidr="10.10.0.0/16",
    connection_types=["PEERING"],
    environment={
        "id": development.id,
    })
gcp = confluentcloud.Peering("gcp",
    display_name="GCP Peering",
    gcp={
        "project": "temp-gear-123456",
        "vpc_network": "customer-test-vpc-network",
    },
    environment={
        "id": development.id,
    },
    network={
        "id": gcp_peering.id,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		gcp_peering, err := confluentcloud.NewNetwork(ctx, "gcp-peering", &confluentcloud.NetworkArgs{
			DisplayName: pulumi.String("GCP Peering Network"),
			Cloud:       pulumi.String("GCP"),
			Region:      pulumi.String("us-west4"),
			Cidr:        pulumi.String("10.10.0.0/16"),
			ConnectionTypes: pulumi.StringArray{
				pulumi.String("PEERING"),
			},
			Environment: &confluentcloud.NetworkEnvironmentArgs{
				Id: development.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewPeering(ctx, "gcp", &confluentcloud.PeeringArgs{
			DisplayName: pulumi.String("GCP Peering"),
			Gcp: &confluentcloud.PeeringGcpArgs{
				Project:    pulumi.String("temp-gear-123456"),
				VpcNetwork: pulumi.String("customer-test-vpc-network"),
			},
			Environment: &confluentcloud.PeeringEnvironmentArgs{
				Id: development.ID(),
			},
			Network: &confluentcloud.PeeringNetworkArgs{
				Id: gcp_peering.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });

    var gcp_peering = new ConfluentCloud.Network("gcp-peering", new()
    {
        DisplayName = "GCP Peering Network",
        Cloud = "GCP",
        Region = "us-west4",
        Cidr = "10.10.0.0/16",
        ConnectionTypes = new[]
        {
            "PEERING",
        },
        Environment = new ConfluentCloud.Inputs.NetworkEnvironmentArgs
        {
            Id = development.Id,
        },
    });

    var gcp = new ConfluentCloud.Peering("gcp", new()
    {
        DisplayName = "GCP Peering",
        Gcp = new ConfluentCloud.Inputs.PeeringGcpArgs
        {
            Project = "temp-gear-123456",
            VpcNetwork = "customer-test-vpc-network",
        },
        Environment = new ConfluentCloud.Inputs.PeeringEnvironmentArgs
        {
            Id = development.Id,
        },
        Network = new ConfluentCloud.Inputs.PeeringNetworkArgs
        {
            Id = gcp_peering.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Network;
import com.pulumi.confluentcloud.NetworkArgs;
import com.pulumi.confluentcloud.inputs.NetworkEnvironmentArgs;
import com.pulumi.confluentcloud.Peering;
import com.pulumi.confluentcloud.PeeringArgs;
import com.pulumi.confluentcloud.inputs.PeeringGcpArgs;
import com.pulumi.confluentcloud.inputs.PeeringEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.PeeringNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());

        var gcp_peering = new Network("gcp-peering", NetworkArgs.builder()
            .displayName("GCP Peering Network")
            .cloud("GCP")
            .region("us-west4")
            .cidr("10.10.0.0/16")
            .connectionTypes("PEERING")
            .environment(NetworkEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .build());

        var gcp = new Peering("gcp", PeeringArgs.builder()
            .displayName("GCP Peering")
            .gcp(PeeringGcpArgs.builder()
                .project("temp-gear-123456")
                .vpcNetwork("customer-test-vpc-network")
                .build())
            .environment(PeeringEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .network(PeeringNetworkArgs.builder()
                .id(gcp_peering.id())
                .build())
            .build());

    }
}
Copy
resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  gcp-peering:
    type: confluentcloud:Network
    properties:
      displayName: GCP Peering Network
      cloud: GCP
      region: us-west4
      cidr: 10.10.0.0/16
      connectionTypes:
        - PEERING
      environment:
        id: ${development.id}
  gcp:
    type: confluentcloud:Peering
    properties:
      displayName: GCP Peering
      gcp:
        project: temp-gear-123456
        vpcNetwork: customer-test-vpc-network
      environment:
        id: ${development.id}
      network:
        id: ${["gcp-peering"].id}
Copy

Getting Started

The following end-to-end examples might help to get started with confluentcloud.Peering resource:

  • dedicated-vnet-peering-azure-kafka-acls: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vnet-peering-azure-kafka-rbac: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-vpc-peering-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vpc-peering-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-vpc-peering-gcp-kafka-acls: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vpc-peering-gcp-kafka-rbac: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-transit-gateway-attachment-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLs
  • dedicated-transit-gateway-attachment-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBAC
  • enterprise-privatelinkattachment-aws-kafka-acls: Enterprise Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs

Create Peering Resource

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

Constructor syntax

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

@overload
def Peering(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            environment: Optional[PeeringEnvironmentArgs] = None,
            network: Optional[PeeringNetworkArgs] = None,
            aws: Optional[PeeringAwsArgs] = None,
            azure: Optional[PeeringAzureArgs] = None,
            display_name: Optional[str] = None,
            gcp: Optional[PeeringGcpArgs] = None)
func NewPeering(ctx *Context, name string, args PeeringArgs, opts ...ResourceOption) (*Peering, error)
public Peering(string name, PeeringArgs args, CustomResourceOptions? opts = null)
public Peering(String name, PeeringArgs args)
public Peering(String name, PeeringArgs args, CustomResourceOptions options)
type: confluentcloud:Peering
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PeeringArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PeeringArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PeeringArgs
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 peeringResource = new ConfluentCloud.Peering("peeringResource", new()
{
    Environment = new ConfluentCloud.Inputs.PeeringEnvironmentArgs
    {
        Id = "string",
    },
    Network = new ConfluentCloud.Inputs.PeeringNetworkArgs
    {
        Id = "string",
    },
    Aws = new ConfluentCloud.Inputs.PeeringAwsArgs
    {
        Account = "string",
        CustomerRegion = "string",
        Routes = new[]
        {
            "string",
        },
        Vpc = "string",
    },
    Azure = new ConfluentCloud.Inputs.PeeringAzureArgs
    {
        CustomerRegion = "string",
        Tenant = "string",
        Vnet = "string",
    },
    DisplayName = "string",
    Gcp = new ConfluentCloud.Inputs.PeeringGcpArgs
    {
        Project = "string",
        VpcNetwork = "string",
        ImportCustomRoutes = false,
    },
});
Copy
example, err := confluentcloud.NewPeering(ctx, "peeringResource", &confluentcloud.PeeringArgs{
	Environment: &confluentcloud.PeeringEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	Network: &confluentcloud.PeeringNetworkArgs{
		Id: pulumi.String("string"),
	},
	Aws: &confluentcloud.PeeringAwsArgs{
		Account:        pulumi.String("string"),
		CustomerRegion: pulumi.String("string"),
		Routes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Vpc: pulumi.String("string"),
	},
	Azure: &confluentcloud.PeeringAzureArgs{
		CustomerRegion: pulumi.String("string"),
		Tenant:         pulumi.String("string"),
		Vnet:           pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Gcp: &confluentcloud.PeeringGcpArgs{
		Project:            pulumi.String("string"),
		VpcNetwork:         pulumi.String("string"),
		ImportCustomRoutes: pulumi.Bool(false),
	},
})
Copy
var peeringResource = new Peering("peeringResource", PeeringArgs.builder()
    .environment(PeeringEnvironmentArgs.builder()
        .id("string")
        .build())
    .network(PeeringNetworkArgs.builder()
        .id("string")
        .build())
    .aws(PeeringAwsArgs.builder()
        .account("string")
        .customerRegion("string")
        .routes("string")
        .vpc("string")
        .build())
    .azure(PeeringAzureArgs.builder()
        .customerRegion("string")
        .tenant("string")
        .vnet("string")
        .build())
    .displayName("string")
    .gcp(PeeringGcpArgs.builder()
        .project("string")
        .vpcNetwork("string")
        .importCustomRoutes(false)
        .build())
    .build());
Copy
peering_resource = confluentcloud.Peering("peeringResource",
    environment={
        "id": "string",
    },
    network={
        "id": "string",
    },
    aws={
        "account": "string",
        "customer_region": "string",
        "routes": ["string"],
        "vpc": "string",
    },
    azure={
        "customer_region": "string",
        "tenant": "string",
        "vnet": "string",
    },
    display_name="string",
    gcp={
        "project": "string",
        "vpc_network": "string",
        "import_custom_routes": False,
    })
Copy
const peeringResource = new confluentcloud.Peering("peeringResource", {
    environment: {
        id: "string",
    },
    network: {
        id: "string",
    },
    aws: {
        account: "string",
        customerRegion: "string",
        routes: ["string"],
        vpc: "string",
    },
    azure: {
        customerRegion: "string",
        tenant: "string",
        vnet: "string",
    },
    displayName: "string",
    gcp: {
        project: "string",
        vpcNetwork: "string",
        importCustomRoutes: false,
    },
});
Copy
type: confluentcloud:Peering
properties:
    aws:
        account: string
        customerRegion: string
        routes:
            - string
        vpc: string
    azure:
        customerRegion: string
        tenant: string
        vnet: string
    displayName: string
    environment:
        id: string
    gcp:
        importCustomRoutes: false
        project: string
        vpcNetwork: string
    network:
        id: string
Copy

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

Environment
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
Aws Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringAws
Azure Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringAzure
DisplayName string
The name of the Peering.
Gcp Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringGcp
Environment
This property is required.
Changes to this property will trigger replacement.
PeeringEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Network
This property is required.
Changes to this property will trigger replacement.
PeeringNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
Aws Changes to this property will trigger replacement. PeeringAwsArgs
Azure Changes to this property will trigger replacement. PeeringAzureArgs
DisplayName string
The name of the Peering.
Gcp Changes to this property will trigger replacement. PeeringGcpArgs
environment
This property is required.
Changes to this property will trigger replacement.
PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAws
azure Changes to this property will trigger replacement. PeeringAzure
displayName String
The name of the Peering.
gcp Changes to this property will trigger replacement. PeeringGcp
environment
This property is required.
Changes to this property will trigger replacement.
PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAws
azure Changes to this property will trigger replacement. PeeringAzure
displayName string
The name of the Peering.
gcp Changes to this property will trigger replacement. PeeringGcp
environment
This property is required.
Changes to this property will trigger replacement.
PeeringEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
PeeringNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAwsArgs
azure Changes to this property will trigger replacement. PeeringAzureArgs
display_name str
The name of the Peering.
gcp Changes to this property will trigger replacement. PeeringGcpArgs
environment
This property is required.
Changes to this property will trigger replacement.
Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
network
This property is required.
Changes to this property will trigger replacement.
Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. Property Map
azure Changes to this property will trigger replacement. Property Map
displayName String
The name of the Peering.
gcp Changes to this property will trigger replacement. Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the Peering 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 Peering Resource

Get an existing Peering 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?: PeeringState, opts?: CustomResourceOptions): Peering
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws: Optional[PeeringAwsArgs] = None,
        azure: Optional[PeeringAzureArgs] = None,
        display_name: Optional[str] = None,
        environment: Optional[PeeringEnvironmentArgs] = None,
        gcp: Optional[PeeringGcpArgs] = None,
        network: Optional[PeeringNetworkArgs] = None) -> Peering
func GetPeering(ctx *Context, name string, id IDInput, state *PeeringState, opts ...ResourceOption) (*Peering, error)
public static Peering Get(string name, Input<string> id, PeeringState? state, CustomResourceOptions? opts = null)
public static Peering get(String name, Output<String> id, PeeringState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:Peering    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Aws Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringAws
Azure Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringAzure
DisplayName string
The name of the Peering.
Environment Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Gcp Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringGcp
Network Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
Aws Changes to this property will trigger replacement. PeeringAwsArgs
Azure Changes to this property will trigger replacement. PeeringAzureArgs
DisplayName string
The name of the Peering.
Environment Changes to this property will trigger replacement. PeeringEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Gcp Changes to this property will trigger replacement. PeeringGcpArgs
Network Changes to this property will trigger replacement. PeeringNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAws
azure Changes to this property will trigger replacement. PeeringAzure
displayName String
The name of the Peering.
environment Changes to this property will trigger replacement. PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcp Changes to this property will trigger replacement. PeeringGcp
network Changes to this property will trigger replacement. PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAws
azure Changes to this property will trigger replacement. PeeringAzure
displayName string
The name of the Peering.
environment Changes to this property will trigger replacement. PeeringEnvironment
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcp Changes to this property will trigger replacement. PeeringGcp
network Changes to this property will trigger replacement. PeeringNetwork
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. PeeringAwsArgs
azure Changes to this property will trigger replacement. PeeringAzureArgs
display_name str
The name of the Peering.
environment Changes to this property will trigger replacement. PeeringEnvironmentArgs
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcp Changes to this property will trigger replacement. PeeringGcpArgs
network Changes to this property will trigger replacement. PeeringNetworkArgs
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
aws Changes to this property will trigger replacement. Property Map
azure Changes to this property will trigger replacement. Property Map
displayName String
The name of the Peering.
environment Changes to this property will trigger replacement. Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
gcp Changes to this property will trigger replacement. Property Map
network Changes to this property will trigger replacement. Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

Supporting Types

PeeringAws
, PeeringAwsArgs

Account
This property is required.
Changes to this property will trigger replacement.
string
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
CustomerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the AWS peer VPC.
Routes
This property is required.
Changes to this property will trigger replacement.
List<string>
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
Vpc
This property is required.
Changes to this property will trigger replacement.
string
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.
Account
This property is required.
Changes to this property will trigger replacement.
string
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
CustomerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the AWS peer VPC.
Routes
This property is required.
Changes to this property will trigger replacement.
[]string
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
Vpc
This property is required.
Changes to this property will trigger replacement.
string
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.
account
This property is required.
Changes to this property will trigger replacement.
String
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
customerRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the AWS peer VPC.
routes
This property is required.
Changes to this property will trigger replacement.
List<String>
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
vpc
This property is required.
Changes to this property will trigger replacement.
String
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.
account
This property is required.
Changes to this property will trigger replacement.
string
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
customerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the AWS peer VPC.
routes
This property is required.
Changes to this property will trigger replacement.
string[]
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
vpc
This property is required.
Changes to this property will trigger replacement.
string
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.
account
This property is required.
Changes to this property will trigger replacement.
str
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
customer_region
This property is required.
Changes to this property will trigger replacement.
str
The region of the AWS peer VPC.
routes
This property is required.
Changes to this property will trigger replacement.
Sequence[str]
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
vpc
This property is required.
Changes to this property will trigger replacement.
str
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.
account
This property is required.
Changes to this property will trigger replacement.
String
The AWS Account ID of the peer VPC owner. You can find your AWS Account ID here under My Account section of the AWS Management Console. Must be a 12 character string.
customerRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the AWS peer VPC.
routes
This property is required.
Changes to this property will trigger replacement.
List<String>
The AWS VPC CIDR blocks or subsets. This must be from the supported CIDR blocks and must not overlap with your Confluent Cloud CIDR block or any other network peering connection VPC CIDR (learn more about the requirements here). You can find AWS VPC CIDR here under Your VPCs > Target VPC > Details section of the AWS Management Console.
vpc
This property is required.
Changes to this property will trigger replacement.
String
The AWS VPC ID of the peer VPC that you're peering with Confluent Cloud. You can find your AWS VPC ID here under Your VPCs section of the AWS Management Console. Must start with vpc-.

PeeringAzure
, PeeringAzureArgs

CustomerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the Azure peer VNet.
Tenant
This property is required.
Changes to this property will trigger replacement.
string
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
Vnet
This property is required.
Changes to this property will trigger replacement.
string
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.
CustomerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the Azure peer VNet.
Tenant
This property is required.
Changes to this property will trigger replacement.
string
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
Vnet
This property is required.
Changes to this property will trigger replacement.
string
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.
customerRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the Azure peer VNet.
tenant
This property is required.
Changes to this property will trigger replacement.
String
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
vnet
This property is required.
Changes to this property will trigger replacement.
String
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.
customerRegion
This property is required.
Changes to this property will trigger replacement.
string
The region of the Azure peer VNet.
tenant
This property is required.
Changes to this property will trigger replacement.
string
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
vnet
This property is required.
Changes to this property will trigger replacement.
string
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.
customer_region
This property is required.
Changes to this property will trigger replacement.
str
The region of the Azure peer VNet.
tenant
This property is required.
Changes to this property will trigger replacement.
str
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
vnet
This property is required.
Changes to this property will trigger replacement.
str
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.
customerRegion
This property is required.
Changes to this property will trigger replacement.
String
The region of the Azure peer VNet.
tenant
This property is required.
Changes to this property will trigger replacement.
String
The Tenant ID that represents an organization in Azure Active Directory. You can find your Azure Tenant ID in the Azure Portal under Azure Active Directory. Must be a valid 32 character UUID string.
vnet
This property is required.
Changes to this property will trigger replacement.
String
The resource (composite) ID of the peer Virtual Network that you're peering with Confluent Cloud, in the format /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.Network/virtualNetworks/<VNet name>. You can find Subscription ID, Resource Group Name and your VNet name under Virtual Networks > Target VNet > Essentials section of your Microsoft Azure Portal.

PeeringEnvironment
, PeeringEnvironmentArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Peering belongs to, for example, env-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Peering belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Peering belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the Peering belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Environment that the Peering belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the Peering belongs to, for example, env-abc123.

PeeringGcp
, PeeringGcpArgs

Project
This property is required.
Changes to this property will trigger replacement.
string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
VpcNetwork
This property is required.
Changes to this property will trigger replacement.
string
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
ImportCustomRoutes Changes to this property will trigger replacement. bool

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

Project
This property is required.
Changes to this property will trigger replacement.
string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
VpcNetwork
This property is required.
Changes to this property will trigger replacement.
string
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
ImportCustomRoutes Changes to this property will trigger replacement. bool

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

project
This property is required.
Changes to this property will trigger replacement.
String
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
vpcNetwork
This property is required.
Changes to this property will trigger replacement.
String
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
importCustomRoutes Changes to this property will trigger replacement. Boolean

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

project
This property is required.
Changes to this property will trigger replacement.
string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
vpcNetwork
This property is required.
Changes to this property will trigger replacement.
string
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
importCustomRoutes Changes to this property will trigger replacement. boolean

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

project
This property is required.
Changes to this property will trigger replacement.
str
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
vpc_network
This property is required.
Changes to this property will trigger replacement.
str
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
import_custom_routes Changes to this property will trigger replacement. bool

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

project
This property is required.
Changes to this property will trigger replacement.
String
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
vpcNetwork
This property is required.
Changes to this property will trigger replacement.
String
The VPC network name that you're peering to Confluent Cloud. You can find your VPC network name under VPC Networks section of your Google Cloud Console.
importCustomRoutes Changes to this property will trigger replacement. Boolean

The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to false. Learn more about considerations / limitations of the Import Custom Routes option here.

Note: Exactly one from the aws, azure, and gcp configuration blocks must be specified.

Note: Learn more about VPC Peering requirements on AWS here.

Note: Learn more about VNet Peering requirements on Azure here.

Note: Learn more about VPC Peering requirements on Google Cloud Platform here.

PeeringNetwork
, PeeringNetworkArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Peering belongs to, for example, n-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Peering belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network that the Peering belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Network that the Peering belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Network that the Peering belongs to, for example, n-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Network that the Peering belongs to, for example, n-abc123.

Import

You can import a Peering by using Environment ID and Peering ID, in the format <Environment ID>/<Peering ID>. The following example shows how to import a Peering:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ pulumi import confluentcloud:index/peering:Peering my_peer env-abc123/peer-abc123
Copy

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.