DescribeNatGatewaysRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeNatGateways operation. Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.

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

public class DescribeNatGatewaysRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeNatGatewaysRequest type exposes the following members

Constructors

	Name	Description
	DescribeNatGatewaysRequest()

Properties

Name	Type	Description
DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. 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`.
Filter	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property Filter. The 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` - 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. `vpc-id` - The ID of the VPC in which the NAT gateway resides. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
MaxResults	System.Nullable<System.Int32>	Gets and sets the property MaxResults. The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NatGatewayIds	System.Collections.Generic.List<System.String>	Gets and sets the property NatGatewayIds. The IDs of the NAT gateways. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
NextToken	System.String	Gets and sets the property NextToken. The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Examples

This example describes the NAT gateway for the specified VPC.

To describe a NAT gateway


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

List<NatGateway> natGateways = response.NatGateways;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer