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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeVpcs.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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) 


11298
11299
11300
11301
11302
11303
 
# File 'lib/aws-sdk-ec2/types.rb', line 11298

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<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.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.

  • ‘isDefault` - Indicates whether the VPC is the default VPC.

  • ‘state` - The state of the VPC (`pending` | `available`).

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

Returns:



11298
11299
11300
11301
11302
11303
 
# File 'lib/aws-sdk-ec2/types.rb', line 11298

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run)
  include Aws::Structure
end

#vpc_ids ⇒ Array<String>

One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

  • (Array<String>) 


11298
11299
11300
11301
11302
11303
 
# File 'lib/aws-sdk-ec2/types.rb', line 11298

class DescribeVpcsRequest < Struct.new(
  :filters,
  :vpc_ids,
  :dry_run)
  include Aws::Structure
end