You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeSubnetsRequest

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

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  subnet_ids: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeSubnets.

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)


10262
10263
10264
10265
10266
10267
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10262

class DescribeSubnetsRequest < Struct.new(
  :filters,
  :subnet_ids,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidrBlock - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • 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 for the subnet.

Returns:



10262
10263
10264
10265
10266
10267
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10262

class DescribeSubnetsRequest < Struct.new(
  :filters,
  :subnet_ids,
  :dry_run)
  include Aws::Structure
end

#subnet_idsArray<String>

One or more subnet IDs.

Default: Describes all your subnets.

Returns:

  • (Array<String>)


10262
10263
10264
10265
10266
10267
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10262

class DescribeSubnetsRequest < Struct.new(
  :filters,
  :subnet_ids,
  :dry_run)
  include Aws::Structure
end