Describe Vpc Peering Connections

ec2_describe_vpc_peering_connections

R Documentation

Describes your VPC peering connections¶

Description¶

Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.

Usage¶

ec2_describe_vpc_peering_connections(NextToken, MaxResults, DryRun,
  VpcPeeringConnectionIds, Filters)

Arguments¶

NextToken

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

MaxResults

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.

DryRun

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.

VpcPeeringConnectionIds

The IDs of the VPC peering connections.

Default: Describes all your VPC peering connections.

Filters

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.

Value¶

A list with the following syntax:

list(
  VpcPeeringConnections = list(
    list(
      AccepterVpcInfo = list(
        CidrBlock = "string",
        Ipv6CidrBlockSet = list(
          list(
            Ipv6CidrBlock = "string"
          )
        ),
        CidrBlockSet = list(
          list(
            CidrBlock = "string"
          )
        ),
        OwnerId = "string",
        PeeringOptions = list(
          AllowDnsResolutionFromRemoteVpc = TRUE|FALSE,
          AllowEgressFromLocalClassicLinkToRemoteVpc = TRUE|FALSE,
          AllowEgressFromLocalVpcToRemoteClassicLink = TRUE|FALSE
        ),
        VpcId = "string",
        Region = "string"
      ),
      ExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      RequesterVpcInfo = list(
        CidrBlock = "string",
        Ipv6CidrBlockSet = list(
          list(
            Ipv6CidrBlock = "string"
          )
        ),
        CidrBlockSet = list(
          list(
            CidrBlock = "string"
          )
        ),
        OwnerId = "string",
        PeeringOptions = list(
          AllowDnsResolutionFromRemoteVpc = TRUE|FALSE,
          AllowEgressFromLocalClassicLinkToRemoteVpc = TRUE|FALSE,
          AllowEgressFromLocalVpcToRemoteClassicLink = TRUE|FALSE
        ),
        VpcId = "string",
        Region = "string"
      ),
      Status = list(
        Code = "initiating-request"|"pending-acceptance"|"active"|"deleted"|"rejected"|"failed"|"expired"|"provisioning"|"deleting",
        Message = "string"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VpcPeeringConnectionId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_vpc_peering_connections(
  NextToken = "string",
  MaxResults = 123,
  DryRun = TRUE|FALSE,
  VpcPeeringConnectionIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)