DescribeCustomerGatewaysRequest Class

Container for the parameters to the DescribeCustomerGateways operation. Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeCustomerGatewaysRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class DescribeCustomerGatewaysRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeCustomerGatewaysRequest type exposes the following members

Constructors

	Name	Description
	DescribeCustomerGatewaysRequest()

Properties

Name Type Description

	Name	Type	Description
	CustomerGatewayIds	System.Collections.Generic.List<System.String>	Gets and sets the property CustomerGatewayIds. One or more customer gateway IDs. Default: Describes all your customer gateways.
	Filters	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property Filters. 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 device's 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`: - 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.

CustomerGatewayIds

System.Collections.Generic.List<System.String>

Gets and sets the property CustomerGatewayIds.

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Filters

System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property Filters.

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 device's 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: - 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.

Examples

This example describes the specified customer gateway.

To describe a customer gateway


var client = new AmazonEC2Client();
var response = client.DescribeCustomerGateways(new DescribeCustomerGatewaysRequest 
{
    CustomerGatewayIds = new List<string> {
        "cgw-0e11f167"
    }
});

List<CustomerGateway> customerGateways = response.CustomerGateways;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5