DescribeVpcsRequest Class | AWS SDK for .NET Version 4

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

Inheritance Hierarchy

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

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

Syntax

public class DescribeVpcsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeVpcsRequest type exposes the following members

Constructors

	Name	Description
	DescribeVpcsRequest()

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`.
Filters	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property Filters. The filters. `cidr` - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, `/28`). `cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the VPC. `cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the VPC. `cidr-block-association.state` - The state of an IPv4 CIDR block associated with the VPC. `dhcp-options-id` - The ID of a set of DHCP options. `ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the VPC. `ipv6-cidr-block-association.ipv6-pool` - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. `ipv6-cidr-block-association.association-id` - The association ID for an IPv6 CIDR block associated with the VPC. `ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the VPC. `is-default` - Indicates whether the VPC is the default VPC. `owner-id` - The ID of the Amazon Web Services account that owns the VPC. `state` - The state of the VPC (`pending` \| `available`). `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. 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.
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.
VpcIds	System.Collections.Generic.List<System.String>	Gets and sets the property VpcIds. The IDs of the VPCs. 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.

Examples

This example describes the specified VPC.

To describe a VPC


var client = new AmazonEC2Client();
var response = client.DescribeVpcs(new DescribeVpcsRequest 
{
    VpcIds = new List<string> {
        "vpc-a01106c2"
    }
});

List<Vpc> vpcs = response.Vpcs;

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