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

volcengine.vpn.Gateway

Explore with Pulumi AI

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

    Example Usage

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

const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: "cn-beijing-a",
    vpcId: fooVpc.id,
});
const fooGateway = new volcengine.vpn.Gateway("fooGateway", {
    vpcId: fooVpc.id,
    subnetId: fooSubnet.id,
    bandwidth: 50,
    vpnGatewayName: "acc-test1",
    description: "acc-test1",
    period: 7,
    projectName: "default",
});

    import pulumi
import pulumi_volcengine as volcengine

foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id="cn-beijing-a",
    vpc_id=foo_vpc.id)
foo_gateway = volcengine.vpn.Gateway("fooGateway",
    vpc_id=foo_vpc.id,
    subnet_id=foo_subnet.id,
    bandwidth=50,
    vpn_gateway_name="acc-test1",
    description="acc-test1",
    period=7,
    project_name="default")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String("cn-beijing-a"),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		_, err = vpn.NewGateway(ctx, "fooGateway", &vpn.GatewayArgs{
			VpcId:          fooVpc.ID(),
			SubnetId:       fooSubnet.ID(),
			Bandwidth:      pulumi.Int(50),
			VpnGatewayName: pulumi.String("acc-test1"),
			Description:    pulumi.String("acc-test1"),
			Period:         pulumi.Int(7),
			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 fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = "cn-beijing-a",
        VpcId = fooVpc.Id,
    });

    var fooGateway = new Volcengine.Vpn.Gateway("fooGateway", new()
    {
        VpcId = fooVpc.Id,
        SubnetId = fooSubnet.Id,
        Bandwidth = 50,
        VpnGatewayName = "acc-test1",
        Description = "acc-test1",
        Period = 7,
        ProjectName = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.vpn.Gateway;
import com.pulumi.volcengine.vpn.GatewayArgs;
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 fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId("cn-beijing-a")
            .vpcId(fooVpc.id())
            .build());

        var fooGateway = new Gateway("fooGateway", GatewayArgs.builder()        
            .vpcId(fooVpc.id())
            .subnetId(fooSubnet.id())
            .bandwidth(50)
            .vpnGatewayName("acc-test1")
            .description("acc-test1")
            .period(7)
            .projectName("default")
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: cn-beijing-a
      vpcId: ${fooVpc.id}
  fooGateway:
    type: volcengine:vpn:Gateway
    properties:
      vpcId: ${fooVpc.id}
      subnetId: ${fooSubnet.id}
      bandwidth: 50
      vpnGatewayName: acc-test1
      description: acc-test1
      period: 7
      projectName: default

    Create Gateway Resource

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

    Constructor syntax

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

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            bandwidth: Optional[int] = None,
            subnet_id: Optional[str] = None,
            vpc_id: Optional[str] = None,
            billing_type: Optional[str] = None,
            description: Optional[str] = None,
            ipsec_enabled: Optional[bool] = None,
            period: Optional[int] = None,
            project_name: Optional[str] = None,
            ssl_enabled: Optional[bool] = None,
            ssl_max_connections: Optional[int] = None,
            tags: Optional[Sequence[GatewayTagArgs]] = None,
            vpn_gateway_name: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: volcengine:vpn:Gateway
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 GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    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 examplegatewayResourceResourceFromVpngateway = new Volcengine.Vpn.Gateway("examplegatewayResourceResourceFromVpngateway", new()
{
    Bandwidth = 0,
    SubnetId = "string",
    VpcId = "string",
    BillingType = "string",
    Description = "string",
    IpsecEnabled = false,
    Period = 0,
    ProjectName = "string",
    SslEnabled = false,
    SslMaxConnections = 0,
    Tags = new[]
    {
        new Volcengine.Vpn.Inputs.GatewayTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    VpnGatewayName = "string",
});

    example, err := vpn.NewGateway(ctx, "examplegatewayResourceResourceFromVpngateway", &vpn.GatewayArgs{
	Bandwidth:         pulumi.Int(0),
	SubnetId:          pulumi.String("string"),
	VpcId:             pulumi.String("string"),
	BillingType:       pulumi.String("string"),
	Description:       pulumi.String("string"),
	IpsecEnabled:      pulumi.Bool(false),
	Period:            pulumi.Int(0),
	ProjectName:       pulumi.String("string"),
	SslEnabled:        pulumi.Bool(false),
	SslMaxConnections: pulumi.Int(0),
	Tags: vpn.GatewayTagArray{
		&vpn.GatewayTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	VpnGatewayName: pulumi.String("string"),
})

    var examplegatewayResourceResourceFromVpngateway = new com.pulumi.volcengine.vpn.Gateway("examplegatewayResourceResourceFromVpngateway", com.pulumi.volcengine.vpn.GatewayArgs.builder()
    .bandwidth(0)
    .subnetId("string")
    .vpcId("string")
    .billingType("string")
    .description("string")
    .ipsecEnabled(false)
    .period(0)
    .projectName("string")
    .sslEnabled(false)
    .sslMaxConnections(0)
    .tags(GatewayTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .vpnGatewayName("string")
    .build());

    examplegateway_resource_resource_from_vpngateway = volcengine.vpn.Gateway("examplegatewayResourceResourceFromVpngateway",
    bandwidth=0,
    subnet_id="string",
    vpc_id="string",
    billing_type="string",
    description="string",
    ipsec_enabled=False,
    period=0,
    project_name="string",
    ssl_enabled=False,
    ssl_max_connections=0,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    vpn_gateway_name="string")

    const examplegatewayResourceResourceFromVpngateway = new volcengine.vpn.Gateway("examplegatewayResourceResourceFromVpngateway", {
    bandwidth: 0,
    subnetId: "string",
    vpcId: "string",
    billingType: "string",
    description: "string",
    ipsecEnabled: false,
    period: 0,
    projectName: "string",
    sslEnabled: false,
    sslMaxConnections: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
    vpnGatewayName: "string",
});

    type: volcengine:vpn:Gateway
properties:
    bandwidth: 0
    billingType: string
    description: string
    ipsecEnabled: false
    period: 0
    projectName: string
    sslEnabled: false
    sslMaxConnections: 0
    subnetId: string
    tags:
        - key: string
          value: string
    vpcId: string
    vpnGatewayName: string

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

    Bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    SubnetId string
    The ID of the subnet where you want to create the VPN gateway.
    VpcId string
    The ID of the VPC where you want to create the VPN gateway.
    BillingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    Description string
    The description of the VPN gateway.
    IpsecEnabled bool
    Whether ipsec is enabled. Default is true.
    Period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The project name of the VPN gateway.
    SslEnabled bool
    Whether ssl is enabled. Default is false.
    SslMaxConnections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    Tags List<GatewayTag>
    Tags.
    VpnGatewayName string
    The name of the VPN gateway.
    Bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    SubnetId string
    The ID of the subnet where you want to create the VPN gateway.
    VpcId string
    The ID of the VPC where you want to create the VPN gateway.
    BillingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    Description string
    The description of the VPN gateway.
    IpsecEnabled bool
    Whether ipsec is enabled. Default is true.
    Period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The project name of the VPN gateway.
    SslEnabled bool
    Whether ssl is enabled. Default is false.
    SslMaxConnections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    Tags []GatewayTagArgs
    Tags.
    VpnGatewayName string
    The name of the VPN gateway.
    bandwidth Integer
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    subnetId String
    The ID of the subnet where you want to create the VPN gateway.
    vpcId String
    The ID of the VPC where you want to create the VPN gateway.
    billingType String
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    description String
    The description of the VPN gateway.
    ipsecEnabled Boolean
    Whether ipsec is enabled. Default is true.
    period Integer
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The project name of the VPN gateway.
    sslEnabled Boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections Integer
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    tags List<GatewayTag>
    Tags.
    vpnGatewayName String
    The name of the VPN gateway.
    bandwidth number
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    subnetId string
    The ID of the subnet where you want to create the VPN gateway.
    vpcId string
    The ID of the VPC where you want to create the VPN gateway.
    billingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    description string
    The description of the VPN gateway.
    ipsecEnabled boolean
    Whether ipsec is enabled. Default is true.
    period number
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName string
    The project name of the VPN gateway.
    sslEnabled boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections number
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    tags GatewayTag[]
    Tags.
    vpnGatewayName string
    The name of the VPN gateway.
    bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    subnet_id str
    The ID of the subnet where you want to create the VPN gateway.
    vpc_id str
    The ID of the VPC where you want to create the VPN gateway.
    billing_type str
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    description str
    The description of the VPN gateway.
    ipsec_enabled bool
    Whether ipsec is enabled. Default is true.
    period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name str
    The project name of the VPN gateway.
    ssl_enabled bool
    Whether ssl is enabled. Default is false.
    ssl_max_connections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    tags Sequence[GatewayTagArgs]
    Tags.
    vpn_gateway_name str
    The name of the VPN gateway.
    bandwidth Number
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    subnetId String
    The ID of the subnet where you want to create the VPN gateway.
    vpcId String
    The ID of the VPC where you want to create the VPN gateway.
    billingType String
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    description String
    The description of the VPN gateway.
    ipsecEnabled Boolean
    Whether ipsec is enabled. Default is true.
    period Number
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The project name of the VPN gateway.
    sslEnabled Boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections Number
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    tags List<Property Map>
    Tags.
    vpnGatewayName String
    The name of the VPN gateway.

    Outputs

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

    AccountId string
    The account ID of the VPN gateway.
    BusinessStatus string
    The business status of the VPN gateway.
    ConnectionCount int
    The connection count of the VPN gateway.
    CreationTime string
    The create time of VPN gateway.
    DeletedTime string
    The deleted time of the VPN gateway.
    ExpiredTime string
    The expired time of the VPN gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the VPN gateway.
    LockReason string
    The lock reason of the VPN gateway.
    RenewType string
    The renew type of the VPN gateway.
    RouteCount int
    The route count of the VPN gateway.
    Status string
    The status of the VPN gateway.
    UpdateTime string
    The update time of VPN gateway.
    VpnGatewayId string
    The ID of the VPN gateway.
    AccountId string
    The account ID of the VPN gateway.
    BusinessStatus string
    The business status of the VPN gateway.
    ConnectionCount int
    The connection count of the VPN gateway.
    CreationTime string
    The create time of VPN gateway.
    DeletedTime string
    The deleted time of the VPN gateway.
    ExpiredTime string
    The expired time of the VPN gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The IP address of the VPN gateway.
    LockReason string
    The lock reason of the VPN gateway.
    RenewType string
    The renew type of the VPN gateway.
    RouteCount int
    The route count of the VPN gateway.
    Status string
    The status of the VPN gateway.
    UpdateTime string
    The update time of VPN gateway.
    VpnGatewayId string
    The ID of the VPN gateway.
    accountId String
    The account ID of the VPN gateway.
    businessStatus String
    The business status of the VPN gateway.
    connectionCount Integer
    The connection count of the VPN gateway.
    creationTime String
    The create time of VPN gateway.
    deletedTime String
    The deleted time of the VPN gateway.
    expiredTime String
    The expired time of the VPN gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the VPN gateway.
    lockReason String
    The lock reason of the VPN gateway.
    renewType String
    The renew type of the VPN gateway.
    routeCount Integer
    The route count of the VPN gateway.
    status String
    The status of the VPN gateway.
    updateTime String
    The update time of VPN gateway.
    vpnGatewayId String
    The ID of the VPN gateway.
    accountId string
    The account ID of the VPN gateway.
    businessStatus string
    The business status of the VPN gateway.
    connectionCount number
    The connection count of the VPN gateway.
    creationTime string
    The create time of VPN gateway.
    deletedTime string
    The deleted time of the VPN gateway.
    expiredTime string
    The expired time of the VPN gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The IP address of the VPN gateway.
    lockReason string
    The lock reason of the VPN gateway.
    renewType string
    The renew type of the VPN gateway.
    routeCount number
    The route count of the VPN gateway.
    status string
    The status of the VPN gateway.
    updateTime string
    The update time of VPN gateway.
    vpnGatewayId string
    The ID of the VPN gateway.
    account_id str
    The account ID of the VPN gateway.
    business_status str
    The business status of the VPN gateway.
    connection_count int
    The connection count of the VPN gateway.
    creation_time str
    The create time of VPN gateway.
    deleted_time str
    The deleted time of the VPN gateway.
    expired_time str
    The expired time of the VPN gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The IP address of the VPN gateway.
    lock_reason str
    The lock reason of the VPN gateway.
    renew_type str
    The renew type of the VPN gateway.
    route_count int
    The route count of the VPN gateway.
    status str
    The status of the VPN gateway.
    update_time str
    The update time of VPN gateway.
    vpn_gateway_id str
    The ID of the VPN gateway.
    accountId String
    The account ID of the VPN gateway.
    businessStatus String
    The business status of the VPN gateway.
    connectionCount Number
    The connection count of the VPN gateway.
    creationTime String
    The create time of VPN gateway.
    deletedTime String
    The deleted time of the VPN gateway.
    expiredTime String
    The expired time of the VPN gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The IP address of the VPN gateway.
    lockReason String
    The lock reason of the VPN gateway.
    renewType String
    The renew type of the VPN gateway.
    routeCount Number
    The route count of the VPN gateway.
    status String
    The status of the VPN gateway.
    updateTime String
    The update time of VPN gateway.
    vpnGatewayId String
    The ID of the VPN gateway.

    Look up Existing Gateway Resource

    Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        bandwidth: Optional[int] = None,
        billing_type: Optional[str] = None,
        business_status: Optional[str] = None,
        connection_count: Optional[int] = None,
        creation_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        expired_time: Optional[str] = None,
        ip_address: Optional[str] = None,
        ipsec_enabled: Optional[bool] = None,
        lock_reason: Optional[str] = None,
        period: Optional[int] = None,
        project_name: Optional[str] = None,
        renew_type: Optional[str] = None,
        route_count: Optional[int] = None,
        ssl_enabled: Optional[bool] = None,
        ssl_max_connections: Optional[int] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[GatewayTagArgs]] = None,
        update_time: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpn_gateway_id: Optional[str] = None,
        vpn_gateway_name: Optional[str] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:vpn:Gateway    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 VPN gateway.
    Bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    BillingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    BusinessStatus string
    The business status of the VPN gateway.
    ConnectionCount int
    The connection count of the VPN gateway.
    CreationTime string
    The create time of VPN gateway.
    DeletedTime string
    The deleted time of the VPN gateway.
    Description string
    The description of the VPN gateway.
    ExpiredTime string
    The expired time of the VPN gateway.
    IpAddress string
    The IP address of the VPN gateway.
    IpsecEnabled bool
    Whether ipsec is enabled. Default is true.
    LockReason string
    The lock reason of the VPN gateway.
    Period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The project name of the VPN gateway.
    RenewType string
    The renew type of the VPN gateway.
    RouteCount int
    The route count of the VPN gateway.
    SslEnabled bool
    Whether ssl is enabled. Default is false.
    SslMaxConnections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    Status string
    The status of the VPN gateway.
    SubnetId string
    The ID of the subnet where you want to create the VPN gateway.
    Tags List<GatewayTag>
    Tags.
    UpdateTime string
    The update time of VPN gateway.
    VpcId string
    The ID of the VPC where you want to create the VPN gateway.
    VpnGatewayId string
    The ID of the VPN gateway.
    VpnGatewayName string
    The name of the VPN gateway.
    AccountId string
    The account ID of the VPN gateway.
    Bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    BillingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    BusinessStatus string
    The business status of the VPN gateway.
    ConnectionCount int
    The connection count of the VPN gateway.
    CreationTime string
    The create time of VPN gateway.
    DeletedTime string
    The deleted time of the VPN gateway.
    Description string
    The description of the VPN gateway.
    ExpiredTime string
    The expired time of the VPN gateway.
    IpAddress string
    The IP address of the VPN gateway.
    IpsecEnabled bool
    Whether ipsec is enabled. Default is true.
    LockReason string
    The lock reason of the VPN gateway.
    Period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The project name of the VPN gateway.
    RenewType string
    The renew type of the VPN gateway.
    RouteCount int
    The route count of the VPN gateway.
    SslEnabled bool
    Whether ssl is enabled. Default is false.
    SslMaxConnections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    Status string
    The status of the VPN gateway.
    SubnetId string
    The ID of the subnet where you want to create the VPN gateway.
    Tags []GatewayTagArgs
    Tags.
    UpdateTime string
    The update time of VPN gateway.
    VpcId string
    The ID of the VPC where you want to create the VPN gateway.
    VpnGatewayId string
    The ID of the VPN gateway.
    VpnGatewayName string
    The name of the VPN gateway.
    accountId String
    The account ID of the VPN gateway.
    bandwidth Integer
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    billingType String
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    businessStatus String
    The business status of the VPN gateway.
    connectionCount Integer
    The connection count of the VPN gateway.
    creationTime String
    The create time of VPN gateway.
    deletedTime String
    The deleted time of the VPN gateway.
    description String
    The description of the VPN gateway.
    expiredTime String
    The expired time of the VPN gateway.
    ipAddress String
    The IP address of the VPN gateway.
    ipsecEnabled Boolean
    Whether ipsec is enabled. Default is true.
    lockReason String
    The lock reason of the VPN gateway.
    period Integer
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The project name of the VPN gateway.
    renewType String
    The renew type of the VPN gateway.
    routeCount Integer
    The route count of the VPN gateway.
    sslEnabled Boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections Integer
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    status String
    The status of the VPN gateway.
    subnetId String
    The ID of the subnet where you want to create the VPN gateway.
    tags List<GatewayTag>
    Tags.
    updateTime String
    The update time of VPN gateway.
    vpcId String
    The ID of the VPC where you want to create the VPN gateway.
    vpnGatewayId String
    The ID of the VPN gateway.
    vpnGatewayName String
    The name of the VPN gateway.
    accountId string
    The account ID of the VPN gateway.
    bandwidth number
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    billingType string
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    businessStatus string
    The business status of the VPN gateway.
    connectionCount number
    The connection count of the VPN gateway.
    creationTime string
    The create time of VPN gateway.
    deletedTime string
    The deleted time of the VPN gateway.
    description string
    The description of the VPN gateway.
    expiredTime string
    The expired time of the VPN gateway.
    ipAddress string
    The IP address of the VPN gateway.
    ipsecEnabled boolean
    Whether ipsec is enabled. Default is true.
    lockReason string
    The lock reason of the VPN gateway.
    period number
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName string
    The project name of the VPN gateway.
    renewType string
    The renew type of the VPN gateway.
    routeCount number
    The route count of the VPN gateway.
    sslEnabled boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections number
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    status string
    The status of the VPN gateway.
    subnetId string
    The ID of the subnet where you want to create the VPN gateway.
    tags GatewayTag[]
    Tags.
    updateTime string
    The update time of VPN gateway.
    vpcId string
    The ID of the VPC where you want to create the VPN gateway.
    vpnGatewayId string
    The ID of the VPN gateway.
    vpnGatewayName string
    The name of the VPN gateway.
    account_id str
    The account ID of the VPN gateway.
    bandwidth int
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    billing_type str
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    business_status str
    The business status of the VPN gateway.
    connection_count int
    The connection count of the VPN gateway.
    creation_time str
    The create time of VPN gateway.
    deleted_time str
    The deleted time of the VPN gateway.
    description str
    The description of the VPN gateway.
    expired_time str
    The expired time of the VPN gateway.
    ip_address str
    The IP address of the VPN gateway.
    ipsec_enabled bool
    Whether ipsec is enabled. Default is true.
    lock_reason str
    The lock reason of the VPN gateway.
    period int
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name str
    The project name of the VPN gateway.
    renew_type str
    The renew type of the VPN gateway.
    route_count int
    The route count of the VPN gateway.
    ssl_enabled bool
    Whether ssl is enabled. Default is false.
    ssl_max_connections int
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    status str
    The status of the VPN gateway.
    subnet_id str
    The ID of the subnet where you want to create the VPN gateway.
    tags Sequence[GatewayTagArgs]
    Tags.
    update_time str
    The update time of VPN gateway.
    vpc_id str
    The ID of the VPC where you want to create the VPN gateway.
    vpn_gateway_id str
    The ID of the VPN gateway.
    vpn_gateway_name str
    The name of the VPN gateway.
    accountId String
    The account ID of the VPN gateway.
    bandwidth Number
    The bandwidth of the VPN gateway. Unit: Mbps. Values: 5, 10, 20, 50, 100, 200, 500.
    billingType String
    The BillingType of the VPN gateway. Valid values: PrePaid, PostPaid.
    businessStatus String
    The business status of the VPN gateway.
    connectionCount Number
    The connection count of the VPN gateway.
    creationTime String
    The create time of VPN gateway.
    deletedTime String
    The deleted time of the VPN gateway.
    description String
    The description of the VPN gateway.
    expiredTime String
    The expired time of the VPN gateway.
    ipAddress String
    The IP address of the VPN gateway.
    ipsecEnabled Boolean
    Whether ipsec is enabled. Default is true.
    lockReason String
    The lock reason of the VPN gateway.
    period Number
    The Period of the VPN gateway. Default value is 12. This parameter is only useful when creating vpn gateway. Default period unit is Month. Value range: 1~9, 12, 24, 36. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The project name of the VPN gateway.
    renewType String
    The renew type of the VPN gateway.
    routeCount Number
    The route count of the VPN gateway.
    sslEnabled Boolean
    Whether ssl is enabled. Default is false.
    sslMaxConnections Number
    The max connections of ssl. This parameter can only be passed in when ssl_enabled is true. Default is 5.
    status String
    The status of the VPN gateway.
    subnetId String
    The ID of the subnet where you want to create the VPN gateway.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of VPN gateway.
    vpcId String
    The ID of the VPC where you want to create the VPN gateway.
    vpnGatewayId String
    The ID of the VPN gateway.
    vpnGatewayName String
    The name of the VPN gateway.

    Supporting Types

    GatewayTag, GatewayTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

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

    $ pulumi import volcengine:vpn/gateway:Gateway default vgw-273zkshb2qayo7fap8t2****

    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