Class: Aws::EC2::Types::DescribeVpcPeeringConnectionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeVpcPeeringConnectionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

• #vpc_peering_connection_ids ⇒ Array<String>

  The IDs of the VPC peering connections.

Instance Attribute Details

#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:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 28241

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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`:&lt;key&gt; - 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:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 28241

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 28241

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 28241

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_peering_connection_ids ⇒ Array<String>

The IDs of the VPC peering connections.

Default: Describes all your VPC peering connections.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 28241

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end