Class: Aws::EC2::Waiters::SubnetAvailable

Inherits:

Object

• Object
• Aws::EC2::Waiters::SubnetAvailable

Defined in:

lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ SubnetAvailable constructor

  A new instance of SubnetAvailable.

• #wait(params = {}) ⇒ Types::DescribeSubnetsResult

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ SubnetAvailable

Returns a new instance of SubnetAvailable.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 40
• :delay (Integer) — default: 15
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'lib/aws-sdk-ec2/waiters.rb', line 1607

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_subnets,
      acceptors: [{
        "expected" => "available",
        "matcher" => "pathAll",
        "state" => "success",
        "argument" => "subnets[].state"
      }]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-ec2/waiters.rb', line 1631

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeSubnetsResult

Returns a response object which responds to the following methods:

• #next_token => String

• #subnets => Array<Types::Subnet>

Options Hash (params):

• :filters (Array<Types::Filter>) —

  The 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.

  • ‘customer-owned-ipv4-pool` - The customer-owned IPv4 address pool associated with the subnet.

  • ‘default-for-az` - Indicates whether this is the default subnet for the Availability Zone (`true` | `false`). You can also use `defaultForAz` as the filter name.

  • ‘enable-dns64` - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

  • ‘enable-lni-at-device-index` - Indicates the device position for local network interfaces in this subnet. For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1).

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

  • ‘ipv6-native` - Indicates whether this is an IPv6 only subnet (`true` | `false`).

  • ‘map-customer-owned-ip-on-launch` - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

  • ‘map-public-ip-on-launch` - Indicates whether instances launched in this subnet receive a public IPv4 address.

  • ‘outpost-arn` - The Amazon Resource Name (ARN) of the Outpost.

  • ‘owner-id` - The ID of the Amazon Web Services account that owns the subnet.

  • ‘private-dns-name-options-on-launch.hostname-type` - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

  • ‘private-dns-name-options-on-launch.enable-resource-name-dns-a-record`

    • Indicates whether to respond to DNS queries for instance hostnames

    with DNS A records.

  • ‘private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record`

    • Indicates whether to respond to DNS queries for instance hostnames

    with DNS AAAA records.

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

• :subnet_ids (Array<String>) —

  The IDs of the subnets.

  Default: Describes all your subnets.

• :next_token (String) —

  The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• :max_results (Integer) —

  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].

  [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

• :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:

• (Types::DescribeSubnetsResult) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #subnets => Array&lt;Types::Subnet&gt;

# File 'lib/aws-sdk-ec2/waiters.rb', line 1626

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end