Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ucloud Provider
  3. API Docs
  4. UdpnConnection
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

ucloud.UdpnConnection

Explore with Pulumi AI

ucloud logo
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

    UDPN (UCloud Dedicated Private Network)，you can use Dedicated Private Network to achieve high-speed, stable, secure, and dedicated communications between different data centers. The most frequent scenario is to create network connection of clusters across regions.

    VPC Peering Connections with UDPN Connection The cross-region Dedicated Private Network must be established if the two VPCs located in different regions are expected to be connected.

    Note The additional packet head will be added and included in the overall length of packet due to the tunneling UDPN adopted. Since the number of the bytes of packet head is fixed, the bigger data packet is, the less usage will be taken for the packet head.

    Example Usage

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

// connect provider's region (cn-bj2) and peer region (cn-sh2)
const example = new ucloud.UdpnConnection("example", {
    bandwidth: 2,
    peerRegion: "cn-sh2",
});

    import pulumi
import pulumi_ucloud as ucloud

# connect provider's region (cn-bj2) and peer region (cn-sh2)
example = ucloud.UdpnConnection("example",
    bandwidth=2,
    peer_region="cn-sh2")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// connect provider's region (cn-bj2) and peer region (cn-sh2)
		_, err := ucloud.NewUdpnConnection(ctx, "example", &ucloud.UdpnConnectionArgs{
			Bandwidth:  pulumi.Float64(2),
			PeerRegion: pulumi.String("cn-sh2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // connect provider's region (cn-bj2) and peer region (cn-sh2)
    var example = new Ucloud.UdpnConnection("example", new()
    {
        Bandwidth = 2,
        PeerRegion = "cn-sh2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ucloud.UdpnConnection;
import com.pulumi.ucloud.UdpnConnectionArgs;
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) {
        // connect provider's region (cn-bj2) and peer region (cn-sh2)
        var example = new UdpnConnection("example", UdpnConnectionArgs.builder()
            .bandwidth(2)
            .peerRegion("cn-sh2")
            .build());

    }
}

    resources:
  # connect provider's region (cn-bj2) and peer region (cn-sh2)
  example:
    type: ucloud:UdpnConnection
    properties:
      bandwidth: 2
      peerRegion: cn-sh2

    Create UdpnConnection Resource

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

    Constructor syntax

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

@overload
def UdpnConnection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   peer_region: Optional[str] = None,
                   bandwidth: Optional[float] = None,
                   charge_type: Optional[str] = None,
                   duration: Optional[float] = None,
                   udpn_connection_id: Optional[str] = None)
    func NewUdpnConnection(ctx *Context, name string, args UdpnConnectionArgs, opts ...ResourceOption) (*UdpnConnection, error)
    public UdpnConnection(string name, UdpnConnectionArgs args, CustomResourceOptions? opts = null)
    public UdpnConnection(String name, UdpnConnectionArgs args)
public UdpnConnection(String name, UdpnConnectionArgs args, CustomResourceOptions options)

    type: ucloud:UdpnConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UdpnConnectionArgs
    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 UdpnConnectionArgs
    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 UdpnConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UdpnConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UdpnConnectionArgs
    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 udpnConnectionResource = new Ucloud.UdpnConnection("udpnConnectionResource", new()
{
    PeerRegion = "string",
    Bandwidth = 0,
    ChargeType = "string",
    Duration = 0,
    UdpnConnectionId = "string",
});

    example, err := ucloud.NewUdpnConnection(ctx, "udpnConnectionResource", &ucloud.UdpnConnectionArgs{
	PeerRegion:       pulumi.String("string"),
	Bandwidth:        pulumi.Float64(0),
	ChargeType:       pulumi.String("string"),
	Duration:         pulumi.Float64(0),
	UdpnConnectionId: pulumi.String("string"),
})

    var udpnConnectionResource = new UdpnConnection("udpnConnectionResource", UdpnConnectionArgs.builder()
    .peerRegion("string")
    .bandwidth(0)
    .chargeType("string")
    .duration(0)
    .udpnConnectionId("string")
    .build());

    udpn_connection_resource = ucloud.UdpnConnection("udpnConnectionResource",
    peer_region="string",
    bandwidth=0,
    charge_type="string",
    duration=0,
    udpn_connection_id="string")

    const udpnConnectionResource = new ucloud.UdpnConnection("udpnConnectionResource", {
    peerRegion: "string",
    bandwidth: 0,
    chargeType: "string",
    duration: 0,
    udpnConnectionId: "string",
});

    type: ucloud:UdpnConnection
properties:
    bandwidth: 0
    chargeType: string
    duration: 0
    peerRegion: string
    udpnConnectionId: string

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

    PeerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    Bandwidth double
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    ChargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    Duration double
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    UdpnConnectionId string
    The ID of the resource UDPN connection.
    PeerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    Bandwidth float64
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    ChargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    Duration float64
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    UdpnConnectionId string
    The ID of the resource UDPN connection.
    peerRegion String
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    bandwidth Double
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType String
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    duration Double
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    udpnConnectionId String
    The ID of the resource UDPN connection.
    peerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    bandwidth number
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    duration number
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    udpnConnectionId string
    The ID of the resource UDPN connection.
    peer_region str
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    bandwidth float
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    charge_type str
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    duration float
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    udpn_connection_id str
    The ID of the resource UDPN connection.
    peerRegion String
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    bandwidth Number
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType String
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    duration Number
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    udpnConnectionId String
    The ID of the resource UDPN connection.

    Outputs

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

    CreateTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    ExpireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    ExpireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    expireTime String
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    expireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    expire_time str
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    expireTime String
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UdpnConnection Resource

    Get an existing UdpnConnection 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?: UdpnConnectionState, opts?: CustomResourceOptions): UdpnConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth: Optional[float] = None,
        charge_type: Optional[str] = None,
        create_time: Optional[str] = None,
        duration: Optional[float] = None,
        expire_time: Optional[str] = None,
        peer_region: Optional[str] = None,
        udpn_connection_id: Optional[str] = None) -> UdpnConnection
    func GetUdpnConnection(ctx *Context, name string, id IDInput, state *UdpnConnectionState, opts ...ResourceOption) (*UdpnConnection, error)
    public static UdpnConnection Get(string name, Input<string> id, UdpnConnectionState? state, CustomResourceOptions? opts = null)
    public static UdpnConnection get(String name, Output<String> id, UdpnConnectionState state, CustomResourceOptions options)
    resources:  _:    type: ucloud:UdpnConnection    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Bandwidth double
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    ChargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    CreateTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    Duration double
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    ExpireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    PeerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    UdpnConnectionId string
    The ID of the resource UDPN connection.
    Bandwidth float64
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    ChargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    CreateTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    Duration float64
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    ExpireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    PeerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    UdpnConnectionId string
    The ID of the resource UDPN connection.
    bandwidth Double
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType String
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    createTime String
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    duration Double
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    expireTime String
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    peerRegion String
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    udpnConnectionId String
    The ID of the resource UDPN connection.
    bandwidth number
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType string
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    createTime string
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    duration number
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    expireTime string
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    peerRegion string
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    udpnConnectionId string
    The ID of the resource UDPN connection.
    bandwidth float
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    charge_type str
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    create_time str
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    duration float
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    expire_time str
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    peer_region str
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    udpn_connection_id str
    The ID of the resource UDPN connection.
    bandwidth Number
    Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). range from 2 - 1000M. The default value is "1"
    chargeType String
    Charge type. Possible values are: "year" as pay by year, "month" as pay by month, "dynamic" as pay by hour. The default value is "month".
    createTime String
    The time of creation for UDPN connection, formatted by RFC3339 time string.
    duration Number
    The duration that you will buy the resource, the default value is "1". It is not required when "dynamic" (pay by hour), the value is "0" when pay by month and the instance will be valid till the last day of that month.
    expireTime String
    The expiration time for UDPN connection, formatted by RFC3339 time string.
    peerRegion String
    The correspondent region of dedicated connection, please refer to the region and availability zone list and UDPN price list.
    udpnConnectionId String
    The ID of the resource UDPN connection.

    Import

    UDPN connection can be imported using the id, e.g.

    $ pulumi import ucloud:index/udpnConnection:UdpnConnection example udpn-abc123456

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

    Package Details

    Repository
    ucloud ucloud/terraform-provider-ucloud
    License
    Notes
    This Pulumi package is based on the ucloud Terraform Provider.
    ucloud logo
    ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
    ucloud/terraform-provider-ucloud