Class: Aws::EC2::Waiters::VpcPeeringConnectionExists

Inherits:

Object

• Object
• Aws::EC2::Waiters::VpcPeeringConnectionExists

Defined in:

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

Instance Method Summary

• #initialize(options) ⇒ VpcPeeringConnectionExists constructor

  A new instance of VpcPeeringConnectionExists.

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

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

Constructor Details

#initialize(options) ⇒ VpcPeeringConnectionExists

Returns a new instance of VpcPeeringConnectionExists.

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 1931

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_vpc_peering_connections,
      acceptors: [
        {
          "matcher" => "status",
          "expected" => 200,
          "state" => "success"
        },
        {
          "matcher" => "error",
          "expected" => "InvalidVpcPeeringConnectionID.NotFound",
          "state" => "retry"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #vpc_peering_connections => Array<Types::VpcPeeringConnection>
• #next_token => String

Parameters:

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

  a customizable set of options

Options Hash (params):

• :next_token (String) —

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

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

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

• :vpc_peering_connection_ids (Array<String>) —

  The IDs of the VPC peering connections.

  Default: Describes all your VPC peering connections.

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

  The filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

  • accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.

  • accepter-vpc-info.vpc-id - The ID of the accepter VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag - 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-peering-connection-id - The ID of the VPC peering connection.

Returns:

• (Types::DescribeVpcPeeringConnectionsResult) —

  Returns a response object which responds to the following methods:

  • #vpc_peering_connections => Array<Types::VpcPeeringConnection>
  • #next_token => String

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

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