You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

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 'gems/aws-sdk-ec2/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 Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

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.

    • 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 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb', line 730

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