Class: Aws::EC2::Waiters::NatGatewayAvailable

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-ec2/waiters.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ NatGatewayAvailable

Returns a new instance of NatGatewayAvailable.

Parameters:

  • options (Hash)

Options Hash (options):

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


686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/aws-sdk-ec2/waiters.rb', line 686

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_nat_gateways,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "nat_gateways[].state",
          "expected" => "available"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "nat_gateways[].state",
          "expected" => "failed"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "nat_gateways[].state",
          "expected" => "deleting"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "nat_gateways[].state",
          "expected" => "deleted"
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "NatGatewayNotFound"
        }
      ]
    )
  }.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. 



735
736
737
 
# File 'lib/aws-sdk-ec2/waiters.rb', line 735

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

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

    One or more filters.

    • ‘nat-gateway-id` - The ID of the NAT gateway.

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

    • ‘subnet-id` - The ID of the subnet in which the NAT gateway resides.

    • ‘vpc-id` - The ID of the VPC in which the NAT gateway resides.

  • :max_results (Integer) —

    The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

    Constraint: If the value specified is greater than 1000, we return only 1000 items.

  • :nat_gateway_ids (Array<String>) —

    One or more NAT gateway IDs.

  • :next_token (String) —

    The token to retrieve the next page of results.

Returns:



730
731
732
 
# File 'lib/aws-sdk-ec2/waiters.rb', line 730

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