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

ucloud.VpnCustomerGateway

Explore with Pulumi AI

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

    Provides a VPN Customer Gateway resource.

    Example Usage

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

const foo = new ucloud.VpnCustomerGateway("foo", {
    ipAddress: "10.0.0.1",
    tag: "tf-acc",
});

    import pulumi
import pulumi_ucloud as ucloud

foo = ucloud.VpnCustomerGateway("foo",
    ip_address="10.0.0.1",
    tag="tf-acc")

    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 {
		_, err := ucloud.NewVpnCustomerGateway(ctx, "foo", &ucloud.VpnCustomerGatewayArgs{
			IpAddress: pulumi.String("10.0.0.1"),
			Tag:       pulumi.String("tf-acc"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Ucloud.VpnCustomerGateway("foo", new()
    {
        IpAddress = "10.0.0.1",
        Tag = "tf-acc",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ucloud.VpnCustomerGateway;
import com.pulumi.ucloud.VpnCustomerGatewayArgs;
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 foo = new VpnCustomerGateway("foo", VpnCustomerGatewayArgs.builder()
            .ipAddress("10.0.0.1")
            .tag("tf-acc")
            .build());

    }
}

    resources:
  foo:
    type: ucloud:VpnCustomerGateway
    properties:
      ipAddress: 10.0.0.1
      tag: tf-acc

    Create VpnCustomerGateway Resource

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

    Constructor syntax

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

@overload
def VpnCustomerGateway(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       ip_address: Optional[str] = None,
                       name: Optional[str] = None,
                       remark: Optional[str] = None,
                       tag: Optional[str] = None,
                       vpn_customer_gateway_id: Optional[str] = None)
    func NewVpnCustomerGateway(ctx *Context, name string, args VpnCustomerGatewayArgs, opts ...ResourceOption) (*VpnCustomerGateway, error)
    public VpnCustomerGateway(string name, VpnCustomerGatewayArgs args, CustomResourceOptions? opts = null)
    public VpnCustomerGateway(String name, VpnCustomerGatewayArgs args)
public VpnCustomerGateway(String name, VpnCustomerGatewayArgs args, CustomResourceOptions options)

    type: ucloud:VpnCustomerGateway
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 VpnCustomerGatewayArgs
    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 VpnCustomerGatewayArgs
    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 VpnCustomerGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnCustomerGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnCustomerGatewayArgs
    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 vpnCustomerGatewayResource = new Ucloud.VpnCustomerGateway("vpnCustomerGatewayResource", new()
{
    IpAddress = "string",
    Name = "string",
    Remark = "string",
    Tag = "string",
    VpnCustomerGatewayId = "string",
});

    example, err := ucloud.NewVpnCustomerGateway(ctx, "vpnCustomerGatewayResource", &ucloud.VpnCustomerGatewayArgs{
	IpAddress:            pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Remark:               pulumi.String("string"),
	Tag:                  pulumi.String("string"),
	VpnCustomerGatewayId: pulumi.String("string"),
})

    var vpnCustomerGatewayResource = new VpnCustomerGateway("vpnCustomerGatewayResource", VpnCustomerGatewayArgs.builder()
    .ipAddress("string")
    .name("string")
    .remark("string")
    .tag("string")
    .vpnCustomerGatewayId("string")
    .build());

    vpn_customer_gateway_resource = ucloud.VpnCustomerGateway("vpnCustomerGatewayResource",
    ip_address="string",
    name="string",
    remark="string",
    tag="string",
    vpn_customer_gateway_id="string")

    const vpnCustomerGatewayResource = new ucloud.VpnCustomerGateway("vpnCustomerGatewayResource", {
    ipAddress: "string",
    name: "string",
    remark: "string",
    tag: "string",
    vpnCustomerGatewayId: "string",
});

    type: ucloud:VpnCustomerGateway
properties:
    ipAddress: string
    name: string
    remark: string
    tag: string
    vpnCustomerGatewayId: string

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

    IpAddress string
    The ip address of the VPN Customer Gateway.

    Name string
    Remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    Tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    VpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    IpAddress string
    The ip address of the VPN Customer Gateway.

    Name string
    Remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    Tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    VpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    ipAddress String
    The ip address of the VPN Customer Gateway.

    name String
    remark String
    The remarks of the VPN Customer Gateway. (Default: "").
    tag String
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId String
    The ID of the resource VPN Customer Gateway.
    ipAddress string
    The ip address of the VPN Customer Gateway.

    name string
    remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    ip_address str
    The ip address of the VPN Customer Gateway.

    name str
    remark str
    The remarks of the VPN Customer Gateway. (Default: "").
    tag str
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpn_customer_gateway_id str
    The ID of the resource VPN Customer Gateway.
    ipAddress String
    The ip address of the VPN Customer Gateway.

    name String
    remark String
    The remarks of the VPN Customer Gateway. (Default: "").
    tag String
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId String
    The ID of the resource VPN Customer Gateway.

    Outputs

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

    CreateTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VpnCustomerGateway Resource

    Get an existing VpnCustomerGateway 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?: VpnCustomerGatewayState, opts?: CustomResourceOptions): VpnCustomerGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        ip_address: Optional[str] = None,
        name: Optional[str] = None,
        remark: Optional[str] = None,
        tag: Optional[str] = None,
        vpn_customer_gateway_id: Optional[str] = None) -> VpnCustomerGateway
    func GetVpnCustomerGateway(ctx *Context, name string, id IDInput, state *VpnCustomerGatewayState, opts ...ResourceOption) (*VpnCustomerGateway, error)
    public static VpnCustomerGateway Get(string name, Input<string> id, VpnCustomerGatewayState? state, CustomResourceOptions? opts = null)
    public static VpnCustomerGateway get(String name, Output<String> id, VpnCustomerGatewayState state, CustomResourceOptions options)
    resources:  _:    type: ucloud:VpnCustomerGateway    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:
    CreateTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    IpAddress string
    The ip address of the VPN Customer Gateway.

    Name string
    Remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    Tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    VpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    CreateTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    IpAddress string
    The ip address of the VPN Customer Gateway.

    Name string
    Remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    Tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    VpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    createTime String
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    ipAddress String
    The ip address of the VPN Customer Gateway.

    name String
    remark String
    The remarks of the VPN Customer Gateway. (Default: "").
    tag String
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId String
    The ID of the resource VPN Customer Gateway.
    createTime string
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    ipAddress string
    The ip address of the VPN Customer Gateway.

    name string
    remark string
    The remarks of the VPN Customer Gateway. (Default: "").
    tag string
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId string
    The ID of the resource VPN Customer Gateway.
    create_time str
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    ip_address str
    The ip address of the VPN Customer Gateway.

    name str
    remark str
    The remarks of the VPN Customer Gateway. (Default: "").
    tag str
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpn_customer_gateway_id str
    The ID of the resource VPN Customer Gateway.
    createTime String
    The creation time for VPN Customer Gateway, formatted in RFC3339 time string.
    ipAddress String
    The ip address of the VPN Customer Gateway.

    name String
    remark String
    The remarks of the VPN Customer Gateway. (Default: "").
    tag String
    A tag assigned to VPN Customer Gateway, which contains at most 63 characters and only support Chinese, English, numbers, '-', '_', and '.'. If it is not filled in or a empty string is filled in, then default tag will be assigned. (Default: Default).
    vpnCustomerGatewayId String
    The ID of the resource VPN Customer Gateway.

    Import

    VPN Customer Gateway can be imported using the id, e.g.

    $ pulumi import ucloud:index/vpnCustomerGateway:VpnCustomerGateway example remotevpngw-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