You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


11364
11365
11366
11367
11368
11369
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11364

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

#filtersArray<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:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • 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:



11364
11365
11366
11367
11368
11369
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11364

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

#vpn_connection_idsArray<String>

One or more VPN connection IDs.

Default: Describes your VPN connections.

Returns:

  • (Array<String>)


11364
11365
11366
11367
11368
11369
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11364

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