ec2_describe_vpn_gateways {aws.ecx} | R Documentation |
Describe Vpn Gateways
Description
Describe Vpn Gateways
Usage
ec2_describe_vpn_gateways(
Filter = NULL,
VpnGatewayId = NULL,
DryRun = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
Filter |
Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional] |
VpnGatewayId |
List. One or more virtual private gateway IDs. Default: Describes all your virtual private gateways. [optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
Filter
One or more filters.
-
amazon-side-asn
- The Autonomous System Number (ASN) for the Amazon side of the gateway. -
attachment.state
- The current state of the attachment between the gateway and the VPC (attaching
\|attached
\|detaching
\|detached
). -
attachment.vpc-id
- The ID of an attached VPC. -
availability-zone
- The Availability Zone for the virtual private gateway (if applicable). -
state
- The state of the virtual private gateway (pending
\|available
\|deleting
\|deleted
). -
tag
:\ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
VpnGatewayId
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
DryRun
Checks whether you have the required permissions
for the action, without actually making the request, and provides an
error response. If you have the required permissions, the error response
is DryRunOperation
. Otherwise, it is
UnauthorizedOperation
.