Alibaba Cloud v3.63.0 published on Monday, Sep 30, 2024 by Pulumi
alicloud.vpn.getGateways
Explore with Pulumi AI
The VPNs data source lists a number of VPNs resource information owned by an Alicloud account.
NOTE: Available since v1.18.0.
Using getGateways
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGateways(args: GetGatewaysArgs, opts?: InvokeOptions): Promise<GetGatewaysResult>
function getGatewaysOutput(args: GetGatewaysOutputArgs, opts?: InvokeOptions): Output<GetGatewaysResult>
def get_gateways(business_status: Optional[str] = None,
enable_ipsec: Optional[bool] = None,
ids: Optional[Sequence[str]] = None,
include_reservation_data: Optional[bool] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
status: Optional[str] = None,
vpc_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewaysResult
def get_gateways_output(business_status: Optional[pulumi.Input[str]] = None,
enable_ipsec: Optional[pulumi.Input[bool]] = None,
ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
include_reservation_data: Optional[pulumi.Input[bool]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
status: Optional[pulumi.Input[str]] = None,
vpc_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewaysResult]
func GetGateways(ctx *Context, args *GetGatewaysArgs, opts ...InvokeOption) (*GetGatewaysResult, error)
func GetGatewaysOutput(ctx *Context, args *GetGatewaysOutputArgs, opts ...InvokeOption) GetGatewaysResultOutput
> Note: This function is named GetGateways
in the Go SDK.
public static class GetGateways
{
public static Task<GetGatewaysResult> InvokeAsync(GetGatewaysArgs args, InvokeOptions? opts = null)
public static Output<GetGatewaysResult> Invoke(GetGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: alicloud:vpn/getGateways:getGateways
arguments:
# arguments dictionary
The following arguments are supported:
- Business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- Enable
Ipsec bool - Indicates whether the IPsec-VPN feature is enabled.
- Ids List<string>
- IDs of the VPN.
- Include
Reservation boolData - Include ineffective ordering data.
- Name
Regex string - A regex string of VPN name.
- Output
File string - Save the result to the file.
- Status string
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Vpc
Id string - Use the VPC ID as the search key.
- Business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- Enable
Ipsec bool - Indicates whether the IPsec-VPN feature is enabled.
- Ids []string
- IDs of the VPN.
- Include
Reservation boolData - Include ineffective ordering data.
- Name
Regex string - A regex string of VPN name.
- Output
File string - Save the result to the file.
- Status string
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Vpc
Id string - Use the VPC ID as the search key.
- business
Status String - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- enable
Ipsec Boolean - Indicates whether the IPsec-VPN feature is enabled.
- ids List<String>
- IDs of the VPN.
- include
Reservation BooleanData - Include ineffective ordering data.
- name
Regex String - A regex string of VPN name.
- output
File String - Save the result to the file.
- status String
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- vpc
Id String - Use the VPC ID as the search key.
- business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- enable
Ipsec boolean - Indicates whether the IPsec-VPN feature is enabled.
- ids string[]
- IDs of the VPN.
- include
Reservation booleanData - Include ineffective ordering data.
- name
Regex string - A regex string of VPN name.
- output
File string - Save the result to the file.
- status string
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- vpc
Id string - Use the VPC ID as the search key.
- business_
status str - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- enable_
ipsec bool - Indicates whether the IPsec-VPN feature is enabled.
- ids Sequence[str]
- IDs of the VPN.
- include_
reservation_ booldata - Include ineffective ordering data.
- name_
regex str - A regex string of VPN name.
- output_
file str - Save the result to the file.
- status str
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- vpc_
id str - Use the VPC ID as the search key.
- business
Status String - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- enable
Ipsec Boolean - Indicates whether the IPsec-VPN feature is enabled.
- ids List<String>
- IDs of the VPN.
- include
Reservation BooleanData - Include ineffective ordering data.
- name
Regex String - A regex string of VPN name.
- output
File String - Save the result to the file.
- status String
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- vpc
Id String - Use the VPC ID as the search key.
getGateways Result
The following output properties are available:
- Gateways
List<Pulumi.
Ali Cloud. Vpn. Outputs. Get Gateways Gateway> - A list of VPN gateways. Each element contains the following attributes:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ids List<string>
- IDs of the VPN.
- Names List<string>
- names of the VPN.
- Business
Status string - The business status of the VPN gateway.
- Enable
Ipsec bool - Whether the ipsec function is enabled.
- Include
Reservation boolData - Name
Regex string - Output
File string - Status string
- The status of the VPN
- Vpc
Id string - ID of the VPC that the VPN belongs.
- Gateways
[]Get
Gateways Gateway - A list of VPN gateways. Each element contains the following attributes:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ids []string
- IDs of the VPN.
- Names []string
- names of the VPN.
- Business
Status string - The business status of the VPN gateway.
- Enable
Ipsec bool - Whether the ipsec function is enabled.
- Include
Reservation boolData - Name
Regex string - Output
File string - Status string
- The status of the VPN
- Vpc
Id string - ID of the VPC that the VPN belongs.
- gateways
List<Get
Gateways Gateway> - A list of VPN gateways. Each element contains the following attributes:
- id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- IDs of the VPN.
- names List<String>
- names of the VPN.
- business
Status String - The business status of the VPN gateway.
- enable
Ipsec Boolean - Whether the ipsec function is enabled.
- include
Reservation BooleanData - name
Regex String - output
File String - status String
- The status of the VPN
- vpc
Id String - ID of the VPC that the VPN belongs.
- gateways
Get
Gateways Gateway[] - A list of VPN gateways. Each element contains the following attributes:
- id string
- The provider-assigned unique ID for this managed resource.
- ids string[]
- IDs of the VPN.
- names string[]
- names of the VPN.
- business
Status string - The business status of the VPN gateway.
- enable
Ipsec boolean - Whether the ipsec function is enabled.
- include
Reservation booleanData - name
Regex string - output
File string - status string
- The status of the VPN
- vpc
Id string - ID of the VPC that the VPN belongs.
- gateways
Sequence[Get
Gateways Gateway] - A list of VPN gateways. Each element contains the following attributes:
- id str
- The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
- IDs of the VPN.
- names Sequence[str]
- names of the VPN.
- business_
status str - The business status of the VPN gateway.
- enable_
ipsec bool - Whether the ipsec function is enabled.
- include_
reservation_ booldata - name_
regex str - output_
file str - status str
- The status of the VPN
- vpc_
id str - ID of the VPC that the VPN belongs.
- gateways List<Property Map>
- A list of VPN gateways. Each element contains the following attributes:
- id String
- The provider-assigned unique ID for this managed resource.
- ids List<String>
- IDs of the VPN.
- names List<String>
- names of the VPN.
- business
Status String - The business status of the VPN gateway.
- enable
Ipsec Boolean - Whether the ipsec function is enabled.
- include
Reservation BooleanData - name
Regex String - output
File String - status String
- The status of the VPN
- vpc
Id String - ID of the VPC that the VPN belongs.
Supporting Types
GetGatewaysGateway
- Auto
Propagate string - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - Business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- Create
Time string - The creation time of the VPN gateway.
- Description string
- The description of the VPN
- Disaster
Recovery stringInternet Ip - 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 stringVswitch Id - The ID of the backup vSwitch to which the VPN gateway is attached.
- Enable
Ipsec string - Indicates whether the IPsec-VPN feature is enabled.
- Enable
Ssl string - Whether the ssl function is enabled.
- End
Time string - The expiration time of the VPN gateway.
- Id string
- ID of the VPN.
- Instance
Charge stringType - The charge type of the VPN gateway.
- Internet
Ip string - The internet ip of the VPN.
- Name string
- The name of the VPN.
- Network
Type string - The network type of the VPN gateway.
- Resource
Group stringId - The ID of the resource group.
- Specification string
- The Specification of the VPN
- Ssl
Connections int - Total count of ssl vpn connections.
- Ssl
Vpn stringInternet Ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Dictionary<string, string>
- The Tag of.
- Vpc
Id string - Use the VPC ID as the search key.
- Vpn
Type string - The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
- Vswitch
Id string - The ID of the vSwitch to which the VPN gateway is attached.
- Auto
Propagate string - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - Business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- Create
Time string - The creation time of the VPN gateway.
- Description string
- The description of the VPN
- Disaster
Recovery stringInternet Ip - 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 stringVswitch Id - The ID of the backup vSwitch to which the VPN gateway is attached.
- Enable
Ipsec string - Indicates whether the IPsec-VPN feature is enabled.
- Enable
Ssl string - Whether the ssl function is enabled.
- End
Time string - The expiration time of the VPN gateway.
- Id string
- ID of the VPN.
- Instance
Charge stringType - The charge type of the VPN gateway.
- Internet
Ip string - The internet ip of the VPN.
- Name string
- The name of the VPN.
- Network
Type string - The network type of the VPN gateway.
- Resource
Group stringId - The ID of the resource group.
- Specification string
- The Specification of the VPN
- Ssl
Connections int - Total count of ssl vpn connections.
- Ssl
Vpn stringInternet Ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- map[string]string
- The Tag of.
- Vpc
Id string - Use the VPC ID as the search key.
- Vpn
Type string - The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
- Vswitch
Id string - The ID of the vSwitch to which the VPN gateway is attached.
- auto
Propagate String - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - business
Status String - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- create
Time String - The creation time of the VPN gateway.
- description String
- The description of the VPN
- disaster
Recovery StringInternet Ip - 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 StringVswitch Id - The ID of the backup vSwitch to which the VPN gateway is attached.
- enable
Ipsec String - Indicates whether the IPsec-VPN feature is enabled.
- enable
Ssl String - Whether the ssl function is enabled.
- end
Time String - The expiration time of the VPN gateway.
- id String
- ID of the VPN.
- instance
Charge StringType - The charge type of the VPN gateway.
- internet
Ip String - The internet ip of the VPN.
- name String
- The name of the VPN.
- network
Type String - The network type of the VPN gateway.
- resource
Group StringId - The ID of the resource group.
- specification String
- The Specification of the VPN
- ssl
Connections Integer - Total count of ssl vpn connections.
- ssl
Vpn StringInternet Ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Map<String,String>
- The Tag of.
- vpc
Id String - Use the VPC ID as the search key.
- vpn
Type String - The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
- vswitch
Id String - The ID of the vSwitch to which the VPN gateway is attached.
- auto
Propagate string - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - business
Status string - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- create
Time string - The creation time of the VPN gateway.
- description string
- The description of the VPN
- disaster
Recovery stringInternet Ip - 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 stringVswitch Id - The ID of the backup vSwitch to which the VPN gateway is attached.
- enable
Ipsec string - Indicates whether the IPsec-VPN feature is enabled.
- enable
Ssl string - Whether the ssl function is enabled.
- end
Time string - The expiration time of the VPN gateway.
- id string
- ID of the VPN.
- instance
Charge stringType - The charge type of the VPN gateway.
- internet
Ip string - The internet ip of the VPN.
- name string
- The name of the VPN.
- network
Type string - The network type of the VPN gateway.
- resource
Group stringId - The ID of the resource group.
- specification string
- The Specification of the VPN
- ssl
Connections number - Total count of ssl vpn connections.
- ssl
Vpn stringInternet Ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- {[key: string]: string}
- The Tag of.
- vpc
Id string - Use the VPC ID as the search key.
- vpn
Type string - The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
- vswitch
Id string - The ID of the vSwitch to which the VPN gateway is attached.
- auto_
propagate str - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - business_
status str - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- create_
time str - The creation time of the VPN gateway.
- description str
- The description of the VPN
- disaster_
recovery_ strinternet_ ip - 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_ strvswitch_ id - The ID of the backup vSwitch to which the VPN gateway is attached.
- enable_
ipsec str - Indicates whether the IPsec-VPN feature is enabled.
- enable_
ssl str - Whether the ssl function is enabled.
- end_
time str - The expiration time of the VPN gateway.
- id str
- ID of the VPN.
- instance_
charge_ strtype - The charge type of the VPN gateway.
- internet_
ip str - The internet ip of the VPN.
- name str
- The name of the VPN.
- network_
type str - The network type of the VPN gateway.
- resource_
group_ strid - The ID of the resource group.
- specification str
- The Specification of the VPN
- ssl_
connections int - Total count of ssl vpn connections.
- ssl_
vpn_ strinternet_ ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Mapping[str, str]
- The Tag of.
- vpc_
id str - Use the VPC ID as the search key.
- 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.
- auto
Propagate String - Whether to automatically propagate BGP routes to the VPC. Valid values:
true
,false
. - business
Status String - Limit search to specific business status - valid value is "Normal", "FinancialLocked".
- create
Time String - The creation time of the VPN gateway.
- description String
- The description of the VPN
- disaster
Recovery StringInternet Ip - 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 StringVswitch Id - The ID of the backup vSwitch to which the VPN gateway is attached.
- enable
Ipsec String - Indicates whether the IPsec-VPN feature is enabled.
- enable
Ssl String - Whether the ssl function is enabled.
- end
Time String - The expiration time of the VPN gateway.
- id String
- ID of the VPN.
- instance
Charge StringType - The charge type of the VPN gateway.
- internet
Ip String - The internet ip of the VPN.
- name String
- The name of the VPN.
- network
Type String - The network type of the VPN gateway.
- resource
Group StringId - The ID of the resource group.
- specification String
- The Specification of the VPN
- ssl
Connections Number - Total count of ssl vpn connections.
- ssl
Vpn StringInternet Ip - 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
- Limit search to specific status - valid value is "Init", "Provisioning", "Active", "Updating", "Deleting".
- Map<String>
- The Tag of.
- vpc
Id String - Use the VPC ID as the search key.
- vpn
Type String - The VPN gateway type. Value: Normal (default): Normal type. NationalStandard: National Secret type.
- vswitch
Id 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.