Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpn
  5. Gateway
Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.vpn.Gateway

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi
pulumi/pulumi-alicloud

    Import

    VPN gateway can be imported using the id, e.g.

    $ pulumi import alicloud:vpn/gateway:Gateway example <id>

    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,
            vpc_id: Optional[str] = None,
            name: Optional[str] = None,
            period: Optional[int] = None,
            disaster_recovery_vswitch_id: Optional[str] = None,
            enable_ipsec: Optional[bool] = None,
            enable_ssl: Optional[bool] = None,
            instance_charge_type: Optional[str] = None,
            auto_pay: Optional[bool] = None,
            network_type: Optional[str] = None,
            payment_type: Optional[str] = None,
            description: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            ssl_connections: Optional[int] = None,
            tags: Optional[Mapping[str, str]] = None,
            auto_propagate: Optional[bool] = None,
            vpn_gateway_name: Optional[str] = None,
            vpn_type: Optional[str] = None,
            vswitch_id: 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: alicloud: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 AliCloud.Vpn.Gateway("examplegatewayResourceResourceFromVpngateway", new()
{
    Bandwidth = 0,
    VpcId = "string",
    Period = 0,
    DisasterRecoveryVswitchId = "string",
    EnableIpsec = false,
    EnableSsl = false,
    AutoPay = false,
    NetworkType = "string",
    PaymentType = "string",
    Description = "string",
    ResourceGroupId = "string",
    SslConnections = 0,
    Tags = 
    {
        { "string", "string" },
    },
    AutoPropagate = false,
    VpnGatewayName = "string",
    VpnType = "string",
    VswitchId = "string",
});

    example, err := vpn.NewGateway(ctx, "examplegatewayResourceResourceFromVpngateway", &vpn.GatewayArgs{
	Bandwidth:                 pulumi.Int(0),
	VpcId:                     pulumi.String("string"),
	Period:                    pulumi.Int(0),
	DisasterRecoveryVswitchId: pulumi.String("string"),
	EnableIpsec:               pulumi.Bool(false),
	EnableSsl:                 pulumi.Bool(false),
	AutoPay:                   pulumi.Bool(false),
	NetworkType:               pulumi.String("string"),
	PaymentType:               pulumi.String("string"),
	Description:               pulumi.String("string"),
	ResourceGroupId:           pulumi.String("string"),
	SslConnections:            pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutoPropagate:  pulumi.Bool(false),
	VpnGatewayName: pulumi.String("string"),
	VpnType:        pulumi.String("string"),
	VswitchId:      pulumi.String("string"),
})

    var examplegatewayResourceResourceFromVpngateway = new com.pulumi.alicloud.vpn.Gateway("examplegatewayResourceResourceFromVpngateway", com.pulumi.alicloud.vpn.GatewayArgs.builder()
    .bandwidth(0)
    .vpcId("string")
    .period(0)
    .disasterRecoveryVswitchId("string")
    .enableIpsec(false)
    .enableSsl(false)
    .autoPay(false)
    .networkType("string")
    .paymentType("string")
    .description("string")
    .resourceGroupId("string")
    .sslConnections(0)
    .tags(Map.of("string", "string"))
    .autoPropagate(false)
    .vpnGatewayName("string")
    .vpnType("string")
    .vswitchId("string")
    .build());

    examplegateway_resource_resource_from_vpngateway = alicloud.vpn.Gateway("examplegatewayResourceResourceFromVpngateway",
    bandwidth=0,
    vpc_id="string",
    period=0,
    disaster_recovery_vswitch_id="string",
    enable_ipsec=False,
    enable_ssl=False,
    auto_pay=False,
    network_type="string",
    payment_type="string",
    description="string",
    resource_group_id="string",
    ssl_connections=0,
    tags={
        "string": "string",
    },
    auto_propagate=False,
    vpn_gateway_name="string",
    vpn_type="string",
    vswitch_id="string")

    const examplegatewayResourceResourceFromVpngateway = new alicloud.vpn.Gateway("examplegatewayResourceResourceFromVpngateway", {
    bandwidth: 0,
    vpcId: "string",
    period: 0,
    disasterRecoveryVswitchId: "string",
    enableIpsec: false,
    enableSsl: false,
    autoPay: false,
    networkType: "string",
    paymentType: "string",
    description: "string",
    resourceGroupId: "string",
    sslConnections: 0,
    tags: {
        string: "string",
    },
    autoPropagate: false,
    vpnGatewayName: "string",
    vpnType: "string",
    vswitchId: "string",
});

    type: alicloud:vpn:Gateway
properties:
    autoPay: false
    autoPropagate: false
    bandwidth: 0
    description: string
    disasterRecoveryVswitchId: string
    enableIpsec: false
    enableSsl: false
    networkType: string
    paymentType: string
    period: 0
    resourceGroupId: string
    sslConnections: 0
    tags:
        string: string
    vpcId: string
    vpnGatewayName: string
    vpnType: string
    vswitchId: 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 specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    VpcId string
    The ID of the VPC to which the VPN gateway belongs.
    AutoPay bool
    Whether to pay automatically. Default value: true. Valid values:
    AutoPropagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    Description string
    The description of the VPN gateway.
    DisasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    EnableIpsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    EnableSsl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    InstanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    Name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    NetworkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    PaymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    Period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    ResourceGroupId string
    The ID of the resource group.
    SslConnections int
    Maximum number of clients.
    Tags Dictionary<string, string>
    The Tag of.
    VpnGatewayName string
    The name of the VPN gateway.
    VpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    VswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    Bandwidth int
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    VpcId string
    The ID of the VPC to which the VPN gateway belongs.
    AutoPay bool
    Whether to pay automatically. Default value: true. Valid values:
    AutoPropagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    Description string
    The description of the VPN gateway.
    DisasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    EnableIpsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    EnableSsl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    InstanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    Name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    NetworkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    PaymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    Period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    ResourceGroupId string
    The ID of the resource group.
    SslConnections int
    Maximum number of clients.
    Tags map[string]string
    The Tag of.
    VpnGatewayName string
    The name of the VPN gateway.
    VpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    VswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    bandwidth Integer
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    vpcId String
    The ID of the VPC to which the VPN gateway belongs.
    autoPay Boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate Boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    description String
    The description of the VPN gateway.
    disasterRecoveryVswitchId String
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec Boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl Boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType String
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    name String
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType String
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType String
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period Integer
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId String
    The ID of the resource group.
    sslConnections Integer
    Maximum number of clients.
    tags Map<String,String>
    The Tag of.
    vpnGatewayName String
    The name of the VPN gateway.
    vpnType String
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId String
    The ID of the VSwitch to which the VPN gateway is attached.
    bandwidth number
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    vpcId string
    The ID of the VPC to which the VPN gateway belongs.
    autoPay boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    description string
    The description of the VPN gateway.
    disasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period number
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId string
    The ID of the resource group.
    sslConnections number
    Maximum number of clients.
    tags {[key: string]: string}
    The Tag of.
    vpnGatewayName string
    The name of the VPN gateway.
    vpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    bandwidth int
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    vpc_id str
    The ID of the VPC to which the VPN gateway belongs.
    auto_pay bool
    Whether to pay automatically. Default value: true. Valid values:
    auto_propagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    description str
    The description of the VPN gateway.
    disaster_recovery_vswitch_id str
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enable_ipsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enable_ssl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instance_charge_type str
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    name str
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    network_type str
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    payment_type str
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resource_group_id str
    The ID of the resource group.
    ssl_connections int
    Maximum number of clients.
    tags Mapping[str, str]
    The Tag of.
    vpn_gateway_name str
    The name of the VPN gateway.
    vpn_type str
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitch_id str
    The ID of the VSwitch to which the VPN gateway is attached.
    bandwidth Number
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    vpcId String
    The ID of the VPC to which the VPN gateway belongs.
    autoPay Boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate Boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    description String
    The description of the VPN gateway.
    disasterRecoveryVswitchId String
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec Boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl Boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType String
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    name String
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType String
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType String
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period Number
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId String
    The ID of the resource group.
    sslConnections Number
    Maximum number of clients.
    tags Map<String>
    The Tag of.
    vpnGatewayName String
    The name of the VPN gateway.
    vpnType String
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId String
    The ID of the VSwitch to which the VPN gateway is attached.

    Outputs

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

    BusinessStatus string
    The business status of the VPN gateway.
    CreateTime int
    The time when the VPN gateway was created.
    DisasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternetIp string
    The internet ip of the VPN.
    SslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    Status string
    The status of the resource.
    BusinessStatus string
    The business status of the VPN gateway.
    CreateTime int
    The time when the VPN gateway was created.
    DisasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternetIp string
    The internet ip of the VPN.
    SslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    Status string
    The status of the resource.
    businessStatus String
    The business status of the VPN gateway.
    createTime Integer
    The time when the VPN gateway was created.
    disasterRecoveryInternetIp String
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    id String
    The provider-assigned unique ID for this managed resource.
    internetIp String
    The internet ip of the VPN.
    sslVpnInternetIp String
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status String
    The status of the resource.
    businessStatus string
    The business status of the VPN gateway.
    createTime number
    The time when the VPN gateway was created.
    disasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    id string
    The provider-assigned unique ID for this managed resource.
    internetIp string
    The internet ip of the VPN.
    sslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status string
    The status of the resource.
    business_status str
    The business status of the VPN gateway.
    create_time int
    The time when the VPN gateway was created.
    disaster_recovery_internet_ip str
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    id str
    The provider-assigned unique ID for this managed resource.
    internet_ip str
    The internet ip of the VPN.
    ssl_vpn_internet_ip str
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status str
    The status of the resource.
    businessStatus String
    The business status of the VPN gateway.
    createTime Number
    The time when the VPN gateway was created.
    disasterRecoveryInternetIp String
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    id String
    The provider-assigned unique ID for this managed resource.
    internetIp String
    The internet ip of the VPN.
    sslVpnInternetIp String
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status String
    The status of the resource.

    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,
        auto_pay: Optional[bool] = None,
        auto_propagate: Optional[bool] = None,
        bandwidth: Optional[int] = None,
        business_status: Optional[str] = None,
        create_time: Optional[int] = None,
        description: Optional[str] = None,
        disaster_recovery_internet_ip: Optional[str] = None,
        disaster_recovery_vswitch_id: Optional[str] = None,
        enable_ipsec: Optional[bool] = None,
        enable_ssl: Optional[bool] = None,
        instance_charge_type: Optional[str] = None,
        internet_ip: Optional[str] = None,
        name: Optional[str] = None,
        network_type: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        ssl_connections: Optional[int] = None,
        ssl_vpn_internet_ip: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None,
        vpn_gateway_name: Optional[str] = None,
        vpn_type: Optional[str] = None,
        vswitch_id: 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: alicloud: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:
    AutoPay bool
    Whether to pay automatically. Default value: true. Valid values:
    AutoPropagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    Bandwidth int
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    BusinessStatus string
    The business status of the VPN gateway.
    CreateTime int
    The time when the VPN gateway was created.
    Description string
    The description of the VPN gateway.
    DisasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    DisasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    EnableIpsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    EnableSsl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    InstanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    InternetIp string
    The internet ip of the VPN.
    Name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    NetworkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    PaymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    Period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    ResourceGroupId string
    The ID of the resource group.
    SslConnections int
    Maximum number of clients.
    SslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    Status string
    The status of the resource.
    Tags Dictionary<string, string>
    The Tag of.
    VpcId string
    The ID of the VPC to which the VPN gateway belongs.
    VpnGatewayName string
    The name of the VPN gateway.
    VpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    VswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    AutoPay bool
    Whether to pay automatically. Default value: true. Valid values:
    AutoPropagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    Bandwidth int
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    BusinessStatus string
    The business status of the VPN gateway.
    CreateTime int
    The time when the VPN gateway was created.
    Description string
    The description of the VPN gateway.
    DisasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    DisasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    EnableIpsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    EnableSsl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    InstanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    InternetIp string
    The internet ip of the VPN.
    Name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    NetworkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    PaymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    Period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    ResourceGroupId string
    The ID of the resource group.
    SslConnections int
    Maximum number of clients.
    SslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    Status string
    The status of the resource.
    Tags map[string]string
    The Tag of.
    VpcId string
    The ID of the VPC to which the VPN gateway belongs.
    VpnGatewayName string
    The name of the VPN gateway.
    VpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    VswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    autoPay Boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate Boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    bandwidth Integer
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    businessStatus String
    The business status of the VPN gateway.
    createTime Integer
    The time when the VPN gateway was created.
    description String
    The description of the VPN gateway.
    disasterRecoveryInternetIp String
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    disasterRecoveryVswitchId String
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec Boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl Boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType String
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    internetIp String
    The internet ip of the VPN.
    name String
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType String
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType String
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period Integer
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId String
    The ID of the resource group.
    sslConnections Integer
    Maximum number of clients.
    sslVpnInternetIp String
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status String
    The status of the resource.
    tags Map<String,String>
    The Tag of.
    vpcId String
    The ID of the VPC to which the VPN gateway belongs.
    vpnGatewayName String
    The name of the VPN gateway.
    vpnType String
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId String
    The ID of the VSwitch to which the VPN gateway is attached.
    autoPay boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    bandwidth number
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    businessStatus string
    The business status of the VPN gateway.
    createTime number
    The time when the VPN gateway was created.
    description string
    The description of the VPN gateway.
    disasterRecoveryInternetIp string
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    disasterRecoveryVswitchId string
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType string
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    internetIp string
    The internet ip of the VPN.
    name string
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType string
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType string
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period number
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId string
    The ID of the resource group.
    sslConnections number
    Maximum number of clients.
    sslVpnInternetIp string
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status string
    The status of the resource.
    tags {[key: string]: string}
    The Tag of.
    vpcId string
    The ID of the VPC to which the VPN gateway belongs.
    vpnGatewayName string
    The name of the VPN gateway.
    vpnType string
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId string
    The ID of the VSwitch to which the VPN gateway is attached.
    auto_pay bool
    Whether to pay automatically. Default value: true. Valid values:
    auto_propagate bool
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    bandwidth int
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    business_status str
    The business status of the VPN gateway.
    create_time int
    The time when the VPN gateway was created.
    description str
    The description of the VPN gateway.
    disaster_recovery_internet_ip str
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    disaster_recovery_vswitch_id str
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enable_ipsec bool
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enable_ssl bool

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instance_charge_type str
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    internet_ip str
    The internet ip of the VPN.
    name str
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    network_type str
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    payment_type str
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period int
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resource_group_id str
    The ID of the resource group.
    ssl_connections int
    Maximum number of clients.
    ssl_vpn_internet_ip str
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status str
    The status of the resource.
    tags Mapping[str, str]
    The Tag of.
    vpc_id str
    The ID of the VPC to which the VPN gateway belongs.
    vpn_gateway_name str
    The name of the VPN gateway.
    vpn_type str
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitch_id str
    The ID of the VSwitch to which the VPN gateway is attached.
    autoPay Boolean
    Whether to pay automatically. Default value: true. Valid values:
    autoPropagate Boolean
    Whether to automatically propagate the BGP route to the VPC. Value: true: Propagate automatically. false: does not propagate automatically.
    bandwidth Number
    The Bandwidth specification of the VPN gateway. Unit: Mbps. If you want to create a public VPN gateway, the value is 5, 10, 20, 50, 100, 200, 500, or 1000. If you want to create a private VPN gateway, the value is 200 or 1000.
    businessStatus String
    The business status of the VPN gateway.
    createTime Number
    The time when the VPN gateway was created.
    description String
    The description of the VPN gateway.
    disasterRecoveryInternetIp String
    The backup public IP address of the VPN gateway. The second IP address assigned by the system to create an IPsec-VPN connection. This parameter is returned only when the VPN gateway supports the dual-tunnel mode.
    disasterRecoveryVswitchId String
    The ID of the backup VSwitch to which the VPN gateway is attached.
    enableIpsec Boolean
    Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
    enableSsl Boolean

    Enable or Disable SSL VPN. At least one type of VPN should be enabled.

    The following arguments will be discarded. Please use new fields as soon as possible:

    instanceChargeType String
    . Field 'instance_charge_type' has been deprecated from provider version 1.216.0. New field 'payment_type' instead.

    Deprecated: Field 'instance_charge_type' has been deprecated since provider version 1.215.0. New field 'payment_type' instead.

    internetIp String
    The internet ip of the VPN.
    name String
    . Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_gateway_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.215.0. New field 'vpn_gateway_name' instead.

    networkType String
    The network type of the VPN gateway. Value: public (default): public VPN gateway. private: private network VPN gateway.
    paymentType String
    Type of payment. Value: Subscription: prepaid PayAsYouGo: Post-paid.
    period Number
    The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
    resourceGroupId String
    The ID of the resource group.
    sslConnections Number
    Maximum number of clients.
    sslVpnInternetIp String
    The IP address of the SSL-VPN connection. This parameter is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
    status String
    The status of the resource.
    tags Map<String>
    The Tag of.
    vpcId String
    The ID of the VPC to which the VPN gateway belongs.
    vpnGatewayName String
    The name of the VPN gateway.
    vpnType String
    The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
    vswitchId String
    The ID of the VSwitch to which the VPN gateway is attached.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.78.0 published on Friday, May 16, 2025 by Pulumi
    pulumi/pulumi-alicloud