Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vpn
  5. CustomerGateway
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.vpn.CustomerGateway

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage customer gateway

    Example Usage

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

const foo = new volcengine.vpn.CustomerGateway("foo", {
    customerGatewayName: "acc-test",
    description: "acc-test",
    ipAddress: "192.0.1.3",
    projectName: "default",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.vpn.CustomerGateway("foo",
    customer_gateway_name="acc-test",
    description="acc-test",
    ip_address="192.0.1.3",
    project_name="default")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpn"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.NewCustomerGateway(ctx, "foo", &vpn.CustomerGatewayArgs{
			CustomerGatewayName: pulumi.String("acc-test"),
			Description:         pulumi.String("acc-test"),
			IpAddress:           pulumi.String("192.0.1.3"),
			ProjectName:         pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Vpn.CustomerGateway("foo", new()
    {
        CustomerGatewayName = "acc-test",
        Description = "acc-test",
        IpAddress = "192.0.1.3",
        ProjectName = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpn.CustomerGateway;
import com.pulumi.volcengine.vpn.CustomerGatewayArgs;
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 CustomerGateway("foo", CustomerGatewayArgs.builder()        
            .customerGatewayName("acc-test")
            .description("acc-test")
            .ipAddress("192.0.1.3")
            .projectName("default")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:vpn:CustomerGateway
    properties:
      customerGatewayName: acc-test
      description: acc-test
      ipAddress: 192.0.1.3
      projectName: default

    Create CustomerGateway Resource

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

    Constructor syntax

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

@overload
def CustomerGateway(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    ip_address: Optional[str] = None,
                    customer_gateway_name: Optional[str] = None,
                    description: Optional[str] = None,
                    project_name: Optional[str] = None)
    func NewCustomerGateway(ctx *Context, name string, args CustomerGatewayArgs, opts ...ResourceOption) (*CustomerGateway, error)
    public CustomerGateway(string name, CustomerGatewayArgs args, CustomResourceOptions? opts = null)
    public CustomerGateway(String name, CustomerGatewayArgs args)
public CustomerGateway(String name, CustomerGatewayArgs args, CustomResourceOptions options)

    type: volcengine:vpn:CustomerGateway
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 CustomerGatewayArgs
    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 CustomerGatewayArgs
    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 CustomerGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomerGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomerGatewayArgs
    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 customerGatewayResource = new Volcengine.Vpn.CustomerGateway("customerGatewayResource", new()
{
    IpAddress = "string",
    CustomerGatewayName = "string",
    Description = "string",
    ProjectName = "string",
});

    example, err := vpn.NewCustomerGateway(ctx, "customerGatewayResource", &vpn.CustomerGatewayArgs{
	IpAddress:           pulumi.String("string"),
	CustomerGatewayName: pulumi.String("string"),
	Description:         pulumi.String("string"),
	ProjectName:         pulumi.String("string"),
})

    var customerGatewayResource = new CustomerGateway("customerGatewayResource", CustomerGatewayArgs.builder()
    .ipAddress("string")
    .customerGatewayName("string")
    .description("string")
    .projectName("string")
    .build());

    customer_gateway_resource = volcengine.vpn.CustomerGateway("customerGatewayResource",
    ip_address="string",
    customer_gateway_name="string",
    description="string",
    project_name="string")

    const customerGatewayResource = new volcengine.vpn.CustomerGateway("customerGatewayResource", {
    ipAddress: "string",
    customerGatewayName: "string",
    description: "string",
    projectName: "string",
});

    type: volcengine:vpn:CustomerGateway
properties:
    customerGatewayName: string
    description: string
    ipAddress: string
    projectName: string

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

    IpAddress string
    The IP address of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    ProjectName string
    The project name of the VPN customer gateway.
    IpAddress string
    The IP address of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    ProjectName string
    The project name of the VPN customer gateway.
    ipAddress String
    The IP address of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    projectName String
    The project name of the VPN customer gateway.
    ipAddress string
    The IP address of the customer gateway.
    customerGatewayName string
    The name of the customer gateway.
    description string
    The description of the customer gateway.
    projectName string
    The project name of the VPN customer gateway.
    ip_address str
    The IP address of the customer gateway.
    customer_gateway_name str
    The name of the customer gateway.
    description str
    The description of the customer gateway.
    project_name str
    The project name of the VPN customer gateway.
    ipAddress String
    The IP address of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    projectName String
    The project name of the VPN customer gateway.

    Outputs

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

    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the customer gateway.
    UpdateTime string
    The update time of customer gateway.
    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the customer gateway.
    UpdateTime string
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Integer
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the customer gateway.
    updateTime String
    The update time of customer gateway.
    accountId string
    The account ID of the customer gateway.
    connectionCount number
    The connection count of the customer gateway.
    creationTime string
    The create time of customer gateway.
    customerGatewayId string
    The ID of the customer gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the customer gateway.
    updateTime string
    The update time of customer gateway.
    account_id str
    The account ID of the customer gateway.
    connection_count int
    The connection count of the customer gateway.
    creation_time str
    The create time of customer gateway.
    customer_gateway_id str
    The ID of the customer gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the customer gateway.
    update_time str
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Number
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the customer gateway.
    updateTime String
    The update time of customer gateway.

    Look up Existing CustomerGateway Resource

    Get an existing CustomerGateway 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?: CustomerGatewayState, opts?: CustomResourceOptions): CustomerGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        connection_count: Optional[int] = None,
        creation_time: Optional[str] = None,
        customer_gateway_id: Optional[str] = None,
        customer_gateway_name: Optional[str] = None,
        description: Optional[str] = None,
        ip_address: Optional[str] = None,
        project_name: Optional[str] = None,
        status: Optional[str] = None,
        update_time: Optional[str] = None) -> CustomerGateway
    func GetCustomerGateway(ctx *Context, name string, id IDInput, state *CustomerGatewayState, opts ...ResourceOption) (*CustomerGateway, error)
    public static CustomerGateway Get(string name, Input<string> id, CustomerGatewayState? state, CustomResourceOptions? opts = null)
    public static CustomerGateway get(String name, Output<String> id, CustomerGatewayState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:vpn:CustomerGateway    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:
    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    IpAddress string
    The IP address of the customer gateway.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway.
    UpdateTime string
    The update time of customer gateway.
    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    IpAddress string
    The IP address of the customer gateway.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway.
    UpdateTime string
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Integer
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    ipAddress String
    The IP address of the customer gateway.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway.
    updateTime String
    The update time of customer gateway.
    accountId string
    The account ID of the customer gateway.
    connectionCount number
    The connection count of the customer gateway.
    creationTime string
    The create time of customer gateway.
    customerGatewayId string
    The ID of the customer gateway.
    customerGatewayName string
    The name of the customer gateway.
    description string
    The description of the customer gateway.
    ipAddress string
    The IP address of the customer gateway.
    projectName string
    The project name of the VPN customer gateway.
    status string
    The status of the customer gateway.
    updateTime string
    The update time of customer gateway.
    account_id str
    The account ID of the customer gateway.
    connection_count int
    The connection count of the customer gateway.
    creation_time str
    The create time of customer gateway.
    customer_gateway_id str
    The ID of the customer gateway.
    customer_gateway_name str
    The name of the customer gateway.
    description str
    The description of the customer gateway.
    ip_address str
    The IP address of the customer gateway.
    project_name str
    The project name of the VPN customer gateway.
    status str
    The status of the customer gateway.
    update_time str
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Number
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    ipAddress String
    The IP address of the customer gateway.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway.
    updateTime String
    The update time of customer gateway.

    Import

    CustomerGateway can be imported using the id, e.g.

    $ pulumi import volcengine:vpn/customerGateway:CustomerGateway default cgw-2byswc356dybk2dx0eed2****

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine