Class: Aws::EC2::Types::DescribeVpcsRequest

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

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpc_ids: ["VpcId"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


26128
26129
26130
26131
26132
26133
26134
26135
26136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26128

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more 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:<key> - 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.

Returns:



26128
26129
26130
26131
26132
26133
26134
26135
26136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26128

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

  • (Integer)


26128
26129
26130
26131
26132
26133
26134
26135
26136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26128

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


26128
26129
26130
26131
26132
26133
26134
26135
26136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26128

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idsArray<String>

One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

  • (Array<String>)


26128
26129
26130
26131
26132
26133
26134
26135
26136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26128

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end