Class: Aws::EC2::Types::DescribeCustomerGatewaysRequest

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

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

Contains the parameters for DescribeCustomerGateways.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#customer_gateway_ids ⇒ Array<String>

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Returns:

  • (Array<String>) 


5742
5743
5744
5745
5746
5747
 
# File 'lib/aws-sdk-ec2/types.rb', line 5742

class DescribeCustomerGatewaysRequest < Struct.new(
  :customer_gateway_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

#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) 


5742
5743
5744
5745
5746
5747
 
# File 'lib/aws-sdk-ec2/types.rb', line 5742

class DescribeCustomerGatewaysRequest < Struct.new(
  :customer_gateway_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters.

  • ‘bgp-asn` - The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • ‘customer-gateway-id` - The ID of the customer gateway.

  • ‘ip-address` - The IP address of the customer gateway’s Internet-routable external interface.

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

  • ‘type` - The type of customer gateway. Currently, the only supported type is `ipsec.1`.

  • ‘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.

Returns:



5742
5743
5744
5745
5746
5747
 
# File 'lib/aws-sdk-ec2/types.rb', line 5742

class DescribeCustomerGatewaysRequest < Struct.new(
  :customer_gateway_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end