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

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

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

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

Contains the parameters for DescribeCustomerGateways.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_gateway_idsArray<String>

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Returns:

  • (Array<String>)


7306
7307
7308
7309
7310
7311
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7306

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

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


7306
7307
7308
7309
7310
7311
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7306

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

#filtersArray<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. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Returns:



7306
7307
7308
7309
7310
7311
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7306

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