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

Inherits:

Object

• Object
• Aws::EC2::Waiters::NatGatewayAvailable

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ NatGatewayAvailable constructor

  A new instance of NatGatewayAvailable.

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

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

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)

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

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:

• #nat_gateways => Array<Types::NatGateway>
• #next_token => String

Parameters:

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

  a customizable set of options

Options Hash (params):

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

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

  The 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> - 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 in which the NAT gateway resides.

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

• :nat_gateway_ids (Array<String>) —

  The IDs of the NAT gateways.

• :next_token (String) —

  The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

• (Types::DescribeNatGatewaysResult) —

  Returns a response object which responds to the following methods:

  • #nat_gateways => Array<Types::NatGateway>
  • #next_token => String

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

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