Docs
Packagesalicloud.vpn.Gateway
Explore with Pulumi AI
Import
VPN gateway can be imported using the id, e.g.
$ pulumi import alicloud:vpn/gateway:Gateway example vpn-abc123456
Create Gateway Resource
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);@overload
def Gateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_pay: Optional[bool] = None,
auto_propagate: Optional[bool] = None,
bandwidth: Optional[int] = None,
description: Optional[str] = None,
enable_ipsec: Optional[bool] = None,
enable_ssl: Optional[bool] = None,
instance_charge_type: Optional[str] = None,
name: Optional[str] = None,
network_type: Optional[str] = None,
period: Optional[int] = None,
ssl_connections: Optional[int] = None,
tags: Optional[Mapping[str, Any]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None)
@overload
def Gateway(resource_name: str,
args: GatewayArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The Gateway resource accepts the following input properties:
- Bandwidth int
- Vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- Auto
Pay bool Whether to pay automatically. Default value:
true. Valid values:- Auto
Propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- Description string
The description of the VPN instance.
- 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.
- Instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- Name string
The name of the VPN. Defaults to null.
- Network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- Period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- Ssl
Connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Dictionary<string, object>
The tags of VPN gateway.
- Vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- Bandwidth int
- Vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- Auto
Pay bool Whether to pay automatically. Default value:
true. Valid values:- Auto
Propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- Description string
The description of the VPN instance.
- 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.
- Instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- Name string
The name of the VPN. Defaults to null.
- Network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- Period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- Ssl
Connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- map[string]interface{}
The tags of VPN gateway.
- Vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- bandwidth Integer
- vpc
Id String The VPN belongs the vpc_id, the field can't be changed.
- auto
Pay Boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate Boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- description String
The description of the VPN instance.
- enable
Ipsec Boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl Boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge StringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- name String
The name of the VPN. Defaults to null.
- network
Type String The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period Integer
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections Integer The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Map<String,Object>
The tags of VPN gateway.
- vswitch
Id String The VPN belongs the vswitch_id, the field can't be changed.
- bandwidth number
- vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- auto
Pay boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- description string
The description of the VPN instance.
- enable
Ipsec boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- name string
The name of the VPN. Defaults to null.
- network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period number
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections number The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- {[key: string]: any}
The tags of VPN gateway.
- vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- bandwidth int
- vpc_
id str The VPN belongs the vpc_id, the field can't be changed.
- auto_
pay bool Whether to pay automatically. Default value:
true. Valid values:- auto_
propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- description str
The description of the VPN instance.
- 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.
- instance_
charge_ strtype The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- name str
The name of the VPN. Defaults to null.
- network_
type str The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl_
connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Mapping[str, Any]
The tags of VPN gateway.
- vswitch_
id str The VPN belongs the vswitch_id, the field can't be changed.
- bandwidth Number
- vpc
Id String The VPN belongs the vpc_id, the field can't be changed.
- auto
Pay Boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate Boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- description String
The description of the VPN instance.
- enable
Ipsec Boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl Boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge StringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- name String
The name of the VPN. Defaults to null.
- network
Type String The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period Number
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections Number The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Map<Any>
The tags of VPN gateway.
- vswitch
Id String The VPN belongs the vswitch_id, the field can't be changed.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Business
Status string The business status of the VPN gateway.
- Id string
The provider-assigned unique ID for this managed resource.
- Internet
Ip string The internet ip of the VPN.
- Status string
The status of the VPN gateway.
- Business
Status string The business status of the VPN gateway.
- Id string
The provider-assigned unique ID for this managed resource.
- Internet
Ip string The internet ip of the VPN.
- Status string
The status of the VPN gateway.
- business
Status String The business status of the VPN gateway.
- id String
The provider-assigned unique ID for this managed resource.
- internet
Ip String The internet ip of the VPN.
- status String
The status of the VPN gateway.
- business
Status string The business status of the VPN gateway.
- id string
The provider-assigned unique ID for this managed resource.
- internet
Ip string The internet ip of the VPN.
- status string
The status of the VPN gateway.
- business_
status str The business status of the VPN gateway.
- id str
The provider-assigned unique ID for this managed resource.
- internet_
ip str The internet ip of the VPN.
- status str
The status of the VPN gateway.
- business
Status String The business status of the VPN gateway.
- id String
The provider-assigned unique ID for this managed resource.
- internet
Ip String The internet ip of the VPN.
- status String
The status 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,
auto_pay: Optional[bool] = None,
auto_propagate: Optional[bool] = None,
bandwidth: Optional[int] = None,
business_status: Optional[str] = None,
description: 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,
period: Optional[int] = None,
ssl_connections: Optional[int] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None) -> Gatewayfunc 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)Resource lookup is not supported in YAML- 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.
- Auto
Pay bool Whether to pay automatically. Default value:
true. Valid values:- Auto
Propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- Bandwidth int
- Business
Status string The business status of the VPN gateway.
- Description string
The description of the VPN instance.
- 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.
- Instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- Internet
Ip string The internet ip of the VPN.
- Name string
The name of the VPN. Defaults to null.
- Network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- Period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- Ssl
Connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Status string
The status of the VPN gateway.
- Dictionary<string, object>
The tags of VPN gateway.
- Vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- Vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- Auto
Pay bool Whether to pay automatically. Default value:
true. Valid values:- Auto
Propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- Bandwidth int
- Business
Status string The business status of the VPN gateway.
- Description string
The description of the VPN instance.
- 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.
- Instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- Internet
Ip string The internet ip of the VPN.
- Name string
The name of the VPN. Defaults to null.
- Network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- Period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- Ssl
Connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- Status string
The status of the VPN gateway.
- map[string]interface{}
The tags of VPN gateway.
- Vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- Vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- auto
Pay Boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate Boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- bandwidth Integer
- business
Status String The business status of the VPN gateway.
- description String
The description of the VPN instance.
- enable
Ipsec Boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl Boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge StringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- internet
Ip String The internet ip of the VPN.
- name String
The name of the VPN. Defaults to null.
- network
Type String The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period Integer
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections Integer The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- status String
The status of the VPN gateway.
- Map<String,Object>
The tags of VPN gateway.
- vpc
Id String The VPN belongs the vpc_id, the field can't be changed.
- vswitch
Id String The VPN belongs the vswitch_id, the field can't be changed.
- auto
Pay boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- bandwidth number
- business
Status string The business status of the VPN gateway.
- description string
The description of the VPN instance.
- enable
Ipsec boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge stringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- internet
Ip string The internet ip of the VPN.
- name string
The name of the VPN. Defaults to null.
- network
Type string The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period number
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections number The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- status string
The status of the VPN gateway.
- {[key: string]: any}
The tags of VPN gateway.
- vpc
Id string The VPN belongs the vpc_id, the field can't be changed.
- vswitch
Id string The VPN belongs the vswitch_id, the field can't be changed.
- auto_
pay bool Whether to pay automatically. Default value:
true. Valid values:- auto_
propagate bool Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- bandwidth int
- business_
status str The business status of the VPN gateway.
- description str
The description of the VPN instance.
- 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.
- instance_
charge_ strtype The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- internet_
ip str The internet ip of the VPN.
- name str
The name of the VPN. Defaults to null.
- network_
type str The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period int
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl_
connections int The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- status str
The status of the VPN gateway.
- Mapping[str, Any]
The tags of VPN gateway.
- vpc_
id str The VPN belongs the vpc_id, the field can't be changed.
- vswitch_
id str The VPN belongs the vswitch_id, the field can't be changed.
- auto
Pay Boolean Whether to pay automatically. Default value:
true. Valid values:- auto
Propagate Boolean Specifies whether to automatically advertise BGP routes to the virtual private cloud (VPC). Valid values:
- bandwidth Number
- business
Status String The business status of the VPN gateway.
- description String
The description of the VPN instance.
- enable
Ipsec Boolean Enable or Disable IPSec VPN. At least one type of VPN should be enabled.
- enable
Ssl Boolean Enable or Disable SSL VPN. At least one type of VPN should be enabled.
- instance
Charge StringType The charge type for instance. If it is an international site account, the valid value is PostPaid, otherwise PrePaid. Default to PostPaid.
- internet
Ip String The internet ip of the VPN.
- name String
The name of the VPN. Defaults to null.
- network
Type String The network type of the VPN gateway. Value:
- public (default): Public VPN gateway.
- private: Private VPN gateway.
NOTE: Private VPN gateway can only be purchased by white list users, and the bandwidth only supports 200M or 1000M; In addition, SSL is not supported.
- period Number
The filed is only required while the InstanceChargeType is PrePaid. Valid values: [1-9, 12, 24, 36]. Default to 1.
- ssl
Connections Number The max connections of SSL VPN. Default to 5. The number of connections supported by each account is different. This field is ignored when enable_ssl is false.
- status String
The status of the VPN gateway.
- Map<Any>
The tags of VPN gateway.
- vpc
Id String The VPN belongs the vpc_id, the field can't be changed.
- vswitch
Id String The VPN belongs the vswitch_id, the field can't be changed.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloudTerraform Provider.