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 929

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 953

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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

Options Hash (params):

• :filters (Array<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.

• :subnet_ids (Array<String>) —

  One or more subnet IDs.

  Default: Describes all your subnets.

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

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

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

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