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 1168

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 1198

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>

Options Hash (params):

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

  One or more 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.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.

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

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

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

• :vpc_ids (Array<String>) —

  One or more VPC IDs.

  Default: Describes all your 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`.

Returns:

• (Types::DescribeVpcsResult) —

  Returns a response object which responds to the following methods:

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

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

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