Describe Vpn Connections

ec2_describe_vpn_connections

R Documentation

Describes one or more of your VPN connections

Description

Describes one or more of your VPN connections.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Usage

ec2_describe_vpn_connections(Filters, VpnConnectionIds, DryRun)

Arguments

Filters

One or more filters.

• customer-gateway-configuration - The configuration information for the customer gateway.

• customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

• state - The state of the VPN connection (pending | available | deleting | deleted).

• option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

• route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

• bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

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

• type - The type of VPN connection. Currently the only supported type is ipsec.1.

• vpn-connection-id - The ID of the VPN connection.

• vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

VpnConnectionIds

One or more VPN connection IDs.

Default: Describes your VPN connections.

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.

Value

A list with the following syntax:

list(
  VpnConnections = list(
    list(
      CustomerGatewayConfiguration = "string",
      CustomerGatewayId = "string",
      Category = "string",
      State = "pending"|"available"|"deleting"|"deleted",
      Type = "ipsec.1",
      VpnConnectionId = "string",
      VpnGatewayId = "string",
      TransitGatewayId = "string",
      CoreNetworkArn = "string",
      CoreNetworkAttachmentArn = "string",
      GatewayAssociationState = "associated"|"not-associated"|"associating"|"disassociating",
      Options = list(
        EnableAcceleration = TRUE|FALSE,
        StaticRoutesOnly = TRUE|FALSE,
        LocalIpv4NetworkCidr = "string",
        RemoteIpv4NetworkCidr = "string",
        LocalIpv6NetworkCidr = "string",
        RemoteIpv6NetworkCidr = "string",
        OutsideIpAddressType = "string",
        TransportTransitGatewayAttachmentId = "string",
        TunnelInsideIpVersion = "ipv4"|"ipv6",
        TunnelOptions = list(
          list(
            OutsideIpAddress = "string",
            TunnelInsideCidr = "string",
            TunnelInsideIpv6Cidr = "string",
            PreSharedKey = "string",
            Phase1LifetimeSeconds = 123,
            Phase2LifetimeSeconds = 123,
            RekeyMarginTimeSeconds = 123,
            RekeyFuzzPercentage = 123,
            ReplayWindowSize = 123,
            DpdTimeoutSeconds = 123,
            DpdTimeoutAction = "string",
            Phase1EncryptionAlgorithms = list(
              list(
                Value = "string"
              )
            ),
            Phase2EncryptionAlgorithms = list(
              list(
                Value = "string"
              )
            ),
            Phase1IntegrityAlgorithms = list(
              list(
                Value = "string"
              )
            ),
            Phase2IntegrityAlgorithms = list(
              list(
                Value = "string"
              )
            ),
            Phase1DHGroupNumbers = list(
              list(
                Value = 123
              )
            ),
            Phase2DHGroupNumbers = list(
              list(
                Value = 123
              )
            ),
            IkeVersions = list(
              list(
                Value = "string"
              )
            ),
            StartupAction = "string",
            LogOptions = list(
              CloudWatchLogOptions = list(
                LogEnabled = TRUE|FALSE,
                LogGroupArn = "string",
                LogOutputFormat = "string"
              )
            ),
            EnableTunnelLifecycleControl = TRUE|FALSE
          )
        )
      ),
      Routes = list(
        list(
          DestinationCidrBlock = "string",
          Source = "Static",
          State = "pending"|"available"|"deleting"|"deleted"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VgwTelemetry = list(
        list(
          AcceptedRouteCount = 123,
          LastStatusChange = as.POSIXct(
            "2015-01-01"
          ),
          OutsideIpAddress = "string",
          Status = "UP"|"DOWN",
          StatusMessage = "string",
          CertificateArn = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_vpn_connections(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  VpnConnectionIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)