Class: Aws::EC2::Waiters::CustomerGatewayAvailable

Inherits:

Object

• Object
• Aws::EC2::Waiters::CustomerGatewayAvailable

Defined in:

lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ CustomerGatewayAvailable constructor

  A new instance of CustomerGatewayAvailable.

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

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

Constructor Details

#initialize(options) ⇒ CustomerGatewayAvailable

Returns a new instance of CustomerGatewayAvailable.

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 187

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_customer_gateways,
      acceptors: [
        {
          "expected" => "available",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "customer_gateways[].state"
        },
        {
          "expected" => "deleted",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "customer_gateways[].state"
        },
        {
          "expected" => "deleting",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "customer_gateways[].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 225

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #customer_gateways => Array<Types::CustomerGateway>

Options Hash (params):

• :customer_gateway_ids (Array<String>) —

  One or more customer gateway IDs.

  Default: Describes all your customer gateways.

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

  One or more filters.

  • ‘bgp-asn` - The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • ‘customer-gateway-id` - The ID of the customer gateway.

  • ‘ip-address` - The IP address of the customer gateway’s Internet-routable external interface.

  • ‘state` - The state of the customer gateway (`pending` | `available` | `deleting` | `deleted`).

  • ‘type` - The type of customer gateway. Currently, the only supported type is `ipsec.1`.

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

• :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::DescribeCustomerGatewaysResult) —

  Returns a response object which responds to the following methods:

  • #customer_gateways => Array&lt;Types::CustomerGateway&gt;

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

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