Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Kurrent Cloud
  4. API Docs
  5. Peering
Viewing docs for Kurrent Cloud v0.3.1
published on Tuesday, Oct 6, 2026 by Kurrent
Schema (JSON)
kurrent-io/pulumi-kurrentcloud

kurrentcloud.Peering

kurrentcloud logo Kurrent Cloud
Viewing docs for Kurrent Cloud v0.3.1
published on Tuesday, Oct 6, 2026 by Kurrent
Schema (JSON)
kurrent-io/pulumi-kurrentcloud

    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,
            network_id: Optional[str] = None,
            peer_account_id: Optional[str] = None,
            peer_network_id: Optional[str] = None,
            peer_network_region: Optional[str] = None,
            peer_resource_provider: Optional[str] = None,
            project_id: Optional[str] = None,
            routes: Optional[Sequence[str]] = None,
            name: Optional[str] = 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: kurrentcloud:Peering
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "kurrentcloud_peering" "name" {
    # resource properties
}

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var peeringResource = new KurrentCloud.Peering("peeringResource", new()
{
    NetworkId = "string",
    PeerAccountId = "string",
    PeerNetworkId = "string",
    PeerNetworkRegion = "string",
    PeerResourceProvider = "string",
    ProjectId = "string",
    Routes = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := kurrentcloud.NewPeering(ctx, "peeringResource", &kurrentcloud.PeeringArgs{
	NetworkId:            pulumi.String("string"),
	PeerAccountId:        pulumi.String("string"),
	PeerNetworkId:        pulumi.String("string"),
	PeerNetworkRegion:    pulumi.String("string"),
	PeerResourceProvider: pulumi.String("string"),
	ProjectId:            pulumi.String("string"),
	Routes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    resource "kurrentcloud_peering" "peeringResource" {
  lifecycle {
    create_before_destroy = true
  }
  network_id             = "string"
  peer_account_id        = "string"
  peer_network_id        = "string"
  peer_network_region    = "string"
  peer_resource_provider = "string"
  project_id             = "string"
  routes                 = ["string"]
  name                   = "string"
}

    var peeringResource = new Peering("peeringResource", PeeringArgs.builder()
    .networkId("string")
    .peerAccountId("string")
    .peerNetworkId("string")
    .peerNetworkRegion("string")
    .peerResourceProvider("string")
    .projectId("string")
    .routes("string")
    .name("string")
    .build());

    peering_resource = kurrentcloud.Peering("peeringResource",
    network_id="string",
    peer_account_id="string",
    peer_network_id="string",
    peer_network_region="string",
    peer_resource_provider="string",
    project_id="string",
    routes=["string"],
    name="string")

    const peeringResource = new kurrentcloud.Peering("peeringResource", {
    networkId: "string",
    peerAccountId: "string",
    peerNetworkId: "string",
    peerNetworkRegion: "string",
    peerResourceProvider: "string",
    projectId: "string",
    routes: ["string"],
    name: "string",
});

    type: kurrentcloud:Peering
properties:
    name: string
    networkId: string
    peerAccountId: string
    peerNetworkId: string
    peerNetworkRegion: string
    peerResourceProvider: string
    projectId: string
    routes:
        - string

    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:

    NetworkId string
    Network ID
    PeerAccountId string
    Account identifier in which to the peer network exists
    PeerNetworkId string
    Network identifier of the peer network exists
    PeerNetworkRegion string
    Provider region in which to the peer network exists
    PeerResourceProvider string
    Cloud Provider in which the target network exists
    ProjectId string
    Project ID
    Routes List<string>
    Routes to create from the Event Store network to the peer network
    Name string
    Human-friendly name for the network
    NetworkId string
    Network ID
    PeerAccountId string
    Account identifier in which to the peer network exists
    PeerNetworkId string
    Network identifier of the peer network exists
    PeerNetworkRegion string
    Provider region in which to the peer network exists
    PeerResourceProvider string
    Cloud Provider in which the target network exists
    ProjectId string
    Project ID
    Routes []string
    Routes to create from the Event Store network to the peer network
    Name string
    Human-friendly name for the network
    network_id string
    Network ID
    peer_account_id string
    Account identifier in which to the peer network exists
    peer_network_id string
    Network identifier of the peer network exists
    peer_network_region string
    Provider region in which to the peer network exists
    peer_resource_provider string
    Cloud Provider in which the target network exists
    project_id string
    Project ID
    routes list(string)
    Routes to create from the Event Store network to the peer network
    name string
    Human-friendly name for the network
    networkId String
    Network ID
    peerAccountId String
    Account identifier in which to the peer network exists
    peerNetworkId String
    Network identifier of the peer network exists
    peerNetworkRegion String
    Provider region in which to the peer network exists
    peerResourceProvider String
    Cloud Provider in which the target network exists
    projectId String
    Project ID
    routes List<String>
    Routes to create from the Event Store network to the peer network
    name String
    Human-friendly name for the network
    networkId string
    Network ID
    peerAccountId string
    Account identifier in which to the peer network exists
    peerNetworkId string
    Network identifier of the peer network exists
    peerNetworkRegion string
    Provider region in which to the peer network exists
    peerResourceProvider string
    Cloud Provider in which the target network exists
    projectId string
    Project ID
    routes string[]
    Routes to create from the Event Store network to the peer network
    name string
    Human-friendly name for the network
    network_id str
    Network ID
    peer_account_id str
    Account identifier in which to the peer network exists
    peer_network_id str
    Network identifier of the peer network exists
    peer_network_region str
    Provider region in which to the peer network exists
    peer_resource_provider str
    Cloud Provider in which the target network exists
    project_id str
    Project ID
    routes Sequence[str]
    Routes to create from the Event Store network to the peer network
    name str
    Human-friendly name for the network
    networkId String
    Network ID
    peerAccountId String
    Account identifier in which to the peer network exists
    peerNetworkId String
    Network identifier of the peer network exists
    peerNetworkRegion String
    Provider region in which to the peer network exists
    peerResourceProvider String
    Cloud Provider in which the target network exists
    projectId String
    Project ID
    routes List<String>
    Routes to create from the Event Store network to the peer network
    name String
    Human-friendly name for the network

    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.
    ProviderMetadata Dictionary<string, string>
    Metadata about the remote end of the peering connection
    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderMetadata map[string]string
    Metadata about the remote end of the peering connection
    id string
    The provider-assigned unique ID for this managed resource.
    provider_metadata map(string)
    Metadata about the remote end of the peering connection
    id String
    The provider-assigned unique ID for this managed resource.
    providerMetadata Map<String,String>
    Metadata about the remote end of the peering connection
    id string
    The provider-assigned unique ID for this managed resource.
    providerMetadata {[key: string]: string}
    Metadata about the remote end of the peering connection
    id str
    The provider-assigned unique ID for this managed resource.
    provider_metadata Mapping[str, str]
    Metadata about the remote end of the peering connection
    id String
    The provider-assigned unique ID for this managed resource.
    providerMetadata Map<String>
    Metadata about the remote end of the peering connection

    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,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        peer_account_id: Optional[str] = None,
        peer_network_id: Optional[str] = None,
        peer_network_region: Optional[str] = None,
        peer_resource_provider: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_metadata: Optional[Mapping[str, str]] = None,
        routes: Optional[Sequence[str]] = 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: kurrentcloud:Peering    get:      id: ${id}
    import {
  to = kurrentcloud_peering.example
  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:
    Name string
    Human-friendly name for the network
    NetworkId string
    Network ID
    PeerAccountId string
    Account identifier in which to the peer network exists
    PeerNetworkId string
    Network identifier of the peer network exists
    PeerNetworkRegion string
    Provider region in which to the peer network exists
    PeerResourceProvider string
    Cloud Provider in which the target network exists
    ProjectId string
    Project ID
    ProviderMetadata Dictionary<string, string>
    Metadata about the remote end of the peering connection
    Routes List<string>
    Routes to create from the Event Store network to the peer network
    Name string
    Human-friendly name for the network
    NetworkId string
    Network ID
    PeerAccountId string
    Account identifier in which to the peer network exists
    PeerNetworkId string
    Network identifier of the peer network exists
    PeerNetworkRegion string
    Provider region in which to the peer network exists
    PeerResourceProvider string
    Cloud Provider in which the target network exists
    ProjectId string
    Project ID
    ProviderMetadata map[string]string
    Metadata about the remote end of the peering connection
    Routes []string
    Routes to create from the Event Store network to the peer network
    name string
    Human-friendly name for the network
    network_id string
    Network ID
    peer_account_id string
    Account identifier in which to the peer network exists
    peer_network_id string
    Network identifier of the peer network exists
    peer_network_region string
    Provider region in which to the peer network exists
    peer_resource_provider string
    Cloud Provider in which the target network exists
    project_id string
    Project ID
    provider_metadata map(string)
    Metadata about the remote end of the peering connection
    routes list(string)
    Routes to create from the Event Store network to the peer network
    name String
    Human-friendly name for the network
    networkId String
    Network ID
    peerAccountId String
    Account identifier in which to the peer network exists
    peerNetworkId String
    Network identifier of the peer network exists
    peerNetworkRegion String
    Provider region in which to the peer network exists
    peerResourceProvider String
    Cloud Provider in which the target network exists
    projectId String
    Project ID
    providerMetadata Map<String,String>
    Metadata about the remote end of the peering connection
    routes List<String>
    Routes to create from the Event Store network to the peer network
    name string
    Human-friendly name for the network
    networkId string
    Network ID
    peerAccountId string
    Account identifier in which to the peer network exists
    peerNetworkId string
    Network identifier of the peer network exists
    peerNetworkRegion string
    Provider region in which to the peer network exists
    peerResourceProvider string
    Cloud Provider in which the target network exists
    projectId string
    Project ID
    providerMetadata {[key: string]: string}
    Metadata about the remote end of the peering connection
    routes string[]
    Routes to create from the Event Store network to the peer network
    name str
    Human-friendly name for the network
    network_id str
    Network ID
    peer_account_id str
    Account identifier in which to the peer network exists
    peer_network_id str
    Network identifier of the peer network exists
    peer_network_region str
    Provider region in which to the peer network exists
    peer_resource_provider str
    Cloud Provider in which the target network exists
    project_id str
    Project ID
    provider_metadata Mapping[str, str]
    Metadata about the remote end of the peering connection
    routes Sequence[str]
    Routes to create from the Event Store network to the peer network
    name String
    Human-friendly name for the network
    networkId String
    Network ID
    peerAccountId String
    Account identifier in which to the peer network exists
    peerNetworkId String
    Network identifier of the peer network exists
    peerNetworkRegion String
    Provider region in which to the peer network exists
    peerResourceProvider String
    Cloud Provider in which the target network exists
    projectId String
    Project ID
    providerMetadata Map<String>
    Metadata about the remote end of the peering connection
    routes List<String>
    Routes to create from the Event Store network to the peer network

    Package Details

    Repository
    kurrentcloud kurrent-io/pulumi-kurrentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kurrentcloud Terraform Provider.
    kurrentcloud logo Kurrent Cloud
    Viewing docs for Kurrent Cloud v0.3.1
    published on Tuesday, Oct 6, 2026 by Kurrent
    Schema (JSON)
    kurrent-io/pulumi-kurrentcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial