confluentcloud.Peering
Explore with Pulumi AI
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
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
Create Peering Resource
new Peering(name: string, args: PeeringArgs, opts?: CustomResourceOptions);
@overload
def Peering(resource_name: 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)
@overload
def Peering(resource_name: str,
args: PeeringArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args PeeringArgs
- 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 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 string
- The unique name of the resource.
- args PeeringArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PeeringArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PeeringArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The Peering resource accepts the following input properties:
- Environment
Pulumi.
Confluent Cloud. Inputs. Peering Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Pulumi.
Confluent Cloud. Inputs. Peering Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Pulumi.
Confluent Cloud. Inputs. Peering Aws - Azure
Pulumi.
Confluent Cloud. Inputs. Peering Azure - Display
Name string The name of the Peering.
- Gcp
Pulumi.
Confluent Cloud. Inputs. Peering Gcp
- Environment
Peering
Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Network
Peering
Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Peering
Aws Args - Azure
Peering
Azure Args - Display
Name string The name of the Peering.
- Gcp
Peering
Gcp Args
- environment
Peering
Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Peering
Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws - azure
Peering
Azure - display
Name String The name of the Peering.
- gcp
Peering
Gcp
- environment
Peering
Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Peering
Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws - azure
Peering
Azure - display
Name string The name of the Peering.
- gcp
Peering
Gcp
- environment
Peering
Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network
Peering
Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws Args - azure
Peering
Azure Args - display_
name str The name of the Peering.
- gcp
Peering
Gcp Args
- environment Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- network Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws Property Map
- azure Property Map
- display
Name String The name of the Peering.
- gcp 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)
Resource lookup is not supported in YAML
- 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.
- Aws
Pulumi.
Confluent Cloud. Inputs. Peering Aws - Azure
Pulumi.
Confluent Cloud. Inputs. Peering Azure - Display
Name string The name of the Peering.
- Environment
Pulumi.
Confluent Cloud. Inputs. Peering Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Gcp
Pulumi.
Confluent Cloud. Inputs. Peering Gcp - Network
Pulumi.
Confluent Cloud. Inputs. Peering Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Aws
Peering
Aws Args - Azure
Peering
Azure Args - Display
Name string The name of the Peering.
- Environment
Peering
Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Gcp
Peering
Gcp Args - Network
Peering
Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws - azure
Peering
Azure - display
Name String The name of the Peering.
- environment
Peering
Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Peering
Gcp - network
Peering
Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws - azure
Peering
Azure - display
Name string The name of the Peering.
- environment
Peering
Environment Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Peering
Gcp - network
Peering
Network Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws
Peering
Aws Args - azure
Peering
Azure Args - display_
name str The name of the Peering.
- environment
Peering
Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp
Peering
Gcp Args - network
Peering
Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- aws Property Map
- azure Property Map
- display
Name String The name of the Peering.
- environment Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- gcp Property Map
- network Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
Supporting Types
PeeringAws, PeeringAwsArgs
- Account 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.
- Customer
Region string The region of the Azure peer VNet.
- Routes 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 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 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.
- Customer
Region string The region of the Azure peer VNet.
- Routes []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 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 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.
- customer
Region String The region of the Azure peer VNet.
- routes 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 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 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.
- customer
Region string The region of the Azure peer VNet.
- routes 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 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 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 str The region of the Azure peer VNet.
- routes 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 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 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.
- customer
Region String The region of the Azure peer VNet.
- routes 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 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
- Customer
Region string The region of the Azure peer VNet.
- Tenant 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 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 string The region of the Azure peer VNet.
- Tenant 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 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 String The region of the Azure peer VNet.
- tenant 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 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 string The region of the Azure peer VNet.
- tenant 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 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 str The region of the Azure peer VNet.
- tenant 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 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.
- customer
Region String The region of the Azure peer VNet.
- tenant 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 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 string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- Id string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id str
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
PeeringGcp, PeeringGcpArgs
- Project string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
- Vpc
Network 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.
- Import
Custom boolRoutes 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
, andgcp
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 string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
- Vpc
Network 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.
- Import
Custom boolRoutes 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
, andgcp
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 String
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
- vpc
Network 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.
- import
Custom BooleanRoutes 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
, andgcp
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 string
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
- vpc
Network 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.
- import
Custom booleanRoutes 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
, andgcp
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 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 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_ boolroutes 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
, andgcp
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 String
The GCP Project ID. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
- vpc
Network 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.
- import
Custom BooleanRoutes 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
, andgcp
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 string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- Id string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id string
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id str
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Peering belongs to, for example,
n-abc123
.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.