AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeNatGateways operation. Describes one or more of the your NAT gateways.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeNatGatewaysRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeNatGatewaysRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Filter System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property Filter.

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

Public Property NatGatewayIds System.Collections.Generic.List<System.String>

Gets and sets the property NatGatewayIds.

One or more NAT gateway IDs.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token to retrieve the next page of results.

Examples

This example describes the NAT gateway for the specified VPC.

To describe a NAT gateway


var response = client.DescribeNatGateways(new DescribeNatGatewaysRequest 
{
    Filter = new List {
        new Filter {
            Name = "vpc-id",
            Values = new List {
                "vpc-1a2b3c4d"
            }
        }
    }
});

List natGateways = response.NatGateways;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms