Class: Aws::EC2::Types::DescribeVpnConnectionsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeVpnConnectionsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpn_connection_ids: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeVpnConnections.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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`.

Returns:

  • (Boolean) 


17337
17338
17339
17340
17341
17342
 
# File 'lib/aws-sdk-ec2/types.rb', line 17337

class DescribeVpnConnectionsRequest < Struct.new(
  :filters,
  :vpn_connection_ids,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters.

  • ‘customer-gateway-configuration` - The configuration information for the customer gateway.

  • ‘customer-gateway-id` - The ID of a customer gateway associated with the VPN connection.

  • ‘state` - The state of the VPN connection (`pending` | `available` | `deleting` | `deleted`).

  • ‘option.static-routes-only` - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • ‘route.destination-cidr-block` - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • ‘bgp-asn` - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • ‘tag`:&lt;key&gt; - 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 key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` 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 VPN connection. Currently the only supported type is `ipsec.1`.

  • ‘vpn-connection-id` - The ID of the VPN connection.

  • ‘vpn-gateway-id` - The ID of a virtual private gateway associated with the VPN connection.

Returns:



17337
17338
17339
17340
17341
17342
 
# File 'lib/aws-sdk-ec2/types.rb', line 17337

class DescribeVpnConnectionsRequest < Struct.new(
  :filters,
  :vpn_connection_ids,
  :dry_run)
  include Aws::Structure
end

#vpn_connection_ids ⇒ Array<String>

One or more VPN connection IDs.

Default: Describes your VPN connections.

Returns:

  • (Array<String>) 


17337
17338
17339
17340
17341
17342
 
# File 'lib/aws-sdk-ec2/types.rb', line 17337

class DescribeVpnConnectionsRequest < Struct.new(
  :filters,
  :vpn_connection_ids,
  :dry_run)
  include Aws::Structure
end