本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 搭配使用 `DescribeVpnConnections` 與 CLI
<a name="example_ec2_DescribeVpnConnections_section"></a>

下列程式碼範例示範如何使用 `DescribeVpnConnections`。

------
#### [ CLI ]

**AWS CLI**  
**範例 1：描述您的 VPN 連線**  
下列 `describe-vpn-connections` 範例描述所有 Site-to-Site VPN 連線。  

```
aws ec2 describe-vpn-connections
```
輸出：  

```
{
    "VpnConnections": [
        {
            "CustomerGatewayConfiguration": "...configuration information...",
            "CustomerGatewayId": "cgw-01234567abcde1234",
            "Category": "VPN",
            "State": "available",
            "Type": "ipsec.1",
            "VpnConnectionId": "vpn-1122334455aabbccd",
            "TransitGatewayId": "tgw-00112233445566aab",
            "Options": {
                "EnableAcceleration": false,
                "StaticRoutesOnly": true,
                "LocalIpv4NetworkCidr": "0.0.0.0/0",
                "RemoteIpv4NetworkCidr": "0.0.0.0/0",
                "TunnelInsideIpVersion": "ipv4"
            },
            "Routes": [],
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "CanadaVPN"
                }
            ],
            "VgwTelemetry": [
                {
                    "AcceptedRouteCount": 0,
                    "LastStatusChange": "2020-07-29T10:35:11.000Z",
                    "OutsideIpAddress": "203.0.113.3",
                    "Status": "DOWN",
                    "StatusMessage": ""
                },
                {
                    "AcceptedRouteCount": 0,
                    "LastStatusChange": "2020-09-02T09:09:33.000Z",
                    "OutsideIpAddress": "203.0.113.5",
                    "Status": "UP",
                    "StatusMessage": ""
                }
            ]
        }
    ]
}
```
如需詳細資訊，請參閱[AWS 《 Site-to-Site VPN 使用者指南》中的 HowSite-to-Site VPN 運作](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)。 *AWS Site-to-Site *  
**範例 2：描述可用的 VPN 連線**  
下列 `describe-vpn-connections` 範例描述狀態為 `available` 的 Site-to-Site VPN 連接。  

```
aws ec2 describe-vpn-connections \
    --filters "Name=state,Values=available"
```
如需詳細資訊，請參閱[AWS 《 Site-to-Site VPN 使用者指南》中的 HowSite-to-Site VPN 運作](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)。 *AWS Site-to-Site *  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-connections.html)。

------
#### [ PowerShell ]

**Tools for PowerShell V4**  
**範例 1：此範例描述指定的 VPN 連線。**  

```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**輸出：**  

```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId            : cgw-1a2b3c4d
Options                      : Amazon.EC2.Model.VpnConnectionOptions
Routes                       : {Amazon.EC2.Model.VpnStaticRoute}
State                        : available
Tags                         : {}
Type                         : ipsec.1
VgwTelemetry                 : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId              : vpn-12345678
VpnGatewayId                 : vgw-1a2b3c4d
```
**範例 2：此範例描述狀態為待處理或可用的任何 VPN 連線。**  

```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )

Get-EC2VpnConnection -Filter $filter
```
**範例 3：此範例描述所有 VPN 連線。**  

```
Get-EC2VpnConnection
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v4/reference)。

**Tools for PowerShell V5**  
**範例 1：此範例描述指定的 VPN 連線。**  

```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**輸出：**  

```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId            : cgw-1a2b3c4d
Options                      : Amazon.EC2.Model.VpnConnectionOptions
Routes                       : {Amazon.EC2.Model.VpnStaticRoute}
State                        : available
Tags                         : {}
Type                         : ipsec.1
VgwTelemetry                 : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId              : vpn-12345678
VpnGatewayId                 : vgw-1a2b3c4d
```
**範例 2：此範例描述狀態為待處理或可用的任何 VPN 連線。**  

```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )

Get-EC2VpnConnection -Filter $filter
```
**範例 3：此範例描述所有 VPN 連線。**  

```
Get-EC2VpnConnection
```
+  如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v5/reference)。

------

如需 AWS SDK 開發人員指南和程式碼範例的完整清單，請參閱 [使用 SDK 建立 Amazon EC2 資源 AWS](sdk-general-information-section.md)。此主題也包含有關入門的資訊和舊版 SDK 的詳細資訊。