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

Class: Aws::EC2::Types::DescribeVpnGatewaysRequest

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 DescribeVpnGatewaysRequest data as a hash:

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

Contains the parameters for DescribeVpnGateways.

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)


13328
13329
13330
13331
13332
13333
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13328

class DescribeVpnGatewaysRequest < Struct.new(
  :filters,
  :vpn_gateway_ids,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::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: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 virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

Returns:



13328
13329
13330
13331
13332
13333
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13328

class DescribeVpnGatewaysRequest < Struct.new(
  :filters,
  :vpn_gateway_ids,
  :dry_run)
  include Aws::Structure
end

#vpn_gateway_idsArray<String>

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns:

  • (Array<String>)


13328
13329
13330
13331
13332
13333
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 13328

class DescribeVpnGatewaysRequest < Struct.new(
  :filters,
  :vpn_gateway_ids,
  :dry_run)
  include Aws::Structure
end