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

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

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

Overview

Note:

When making an API call, you may pass DescribeVpcPeeringConnectionsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  vpc_peering_connection_ids: ["String"],
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


17116
17117
17118
17119
17120
17121
17122
17123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17116

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

#filtersArray<Types::Filter>

One or more filters.

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

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of 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 AWS account ID of the owner of 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:<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-peering-connection-id - The ID of the VPC peering connection.

Returns:



17116
17117
17118
17119
17120
17121
17122
17123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17116

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

#max_resultsInteger

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

  • (Integer)


17116
17117
17118
17119
17120
17121
17122
17123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17116

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


17116
17117
17118
17119
17120
17121
17122
17123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17116

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

#vpc_peering_connection_idsArray<String>

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

Returns:

  • (Array<String>)


17116
17117
17118
17119
17120
17121
17122
17123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17116

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