Class: Aws::EC2::Waiters::VpcExists

Inherits:

Object

• Object
• Aws::EC2::Waiters::VpcExists

Defined in:

lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ VpcExists constructor

  A new instance of VpcExists.

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

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

Constructor Details

#initialize(options) ⇒ VpcExists

Returns a new instance of VpcExists.

Parameters:

• options (Hash)

Options Hash (options):

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

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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_vpcs,
      acceptors: [
        {
          "matcher" => "status",
          "expected" => 200,
          "state" => "success"
        },
        {
          "matcher" => "error",
          "expected" => "InvalidVpcID.NotFound",
          "state" => "retry"
        }
      ]
    )
  }.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 1533

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #vpcs => Array<Types::Vpc>

• #next_token => String

Options Hash (params):

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

  The 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.ipv6-pool` - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

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

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

  • ‘tag`:&lt;key&gt; - 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.

• :vpc_ids (Array<String>) —

  The IDs of the VPCs.

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

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

Returns:

• (Types::DescribeVpcsResult) —

  Returns a response object which responds to the following methods:

  • #vpcs => Array&lt;Types::Vpc&gt;

  • #next_token => String

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

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