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,
  next_token: "String",
  max_results: 1,
}

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)


16331
16332
16333
16334
16335
16336
16337
16338
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16331

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

#filtersArray<Types::Filter>

One or more filters.

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

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

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

  • cidr-block - 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 cidrBlock as the filter names.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz 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.

  • owner-id - The ID of the AWS account that owns the subnet.

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

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

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

Returns:



16331
16332
16333
16334
16335
16336
16337
16338
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16331

class DescribeSubnetsRequest < Struct.new(
  :filters,
  :subnet_ids,
  :dry_run,
  :next_token,
  :max_results)
  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)


16331
16332
16333
16334
16335
16336
16337
16338
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16331

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


16331
16332
16333
16334
16335
16336
16337
16338
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16331

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

#subnet_idsArray<String>

One or more subnet IDs.

Default: Describes all your subnets.

Returns:

  • (Array<String>)


16331
16332
16333
16334
16335
16336
16337
16338
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16331

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