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"],
}

Contains the parameters for DescribeVpcPeeringConnections.

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)


11398
11399
11400
11401
11402
11403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11398

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

#filtersArray<Types::Filter>

One or more filters.

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

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer 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 | deleted | rejected).

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

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

Returns:



11398
11399
11400
11401
11402
11403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11398

class DescribeVpcPeeringConnectionsRequest < Struct.new(
  :filters,
  :dry_run,
  :vpc_peering_connection_ids)
  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>)


11398
11399
11400
11401
11402
11403
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11398

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