Skip to content

Modify Vpn Connection Options

ec2_modify_vpn_connection_options R Documentation

Modifies the connection options for your Site-to-Site VPN connection

Description

Modifies the connection options for your Site-to-Site VPN connection.

When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

Usage

ec2_modify_vpn_connection_options(VpnConnectionId, LocalIpv4NetworkCidr,
  RemoteIpv4NetworkCidr, LocalIpv6NetworkCidr, RemoteIpv6NetworkCidr,
  DryRun)

Arguments

VpnConnectionId

[required] The ID of the Site-to-Site VPN connection.

LocalIpv4NetworkCidr

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ⁠0.0.0.0/0⁠

RemoteIpv4NetworkCidr

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

Default: ⁠0.0.0.0/0⁠

LocalIpv6NetworkCidr

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ⁠::/0⁠

RemoteIpv6NetworkCidr

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ⁠::/0⁠

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(
  VpnConnection = 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$modify_vpn_connection_options(
  VpnConnectionId = "string",
  LocalIpv4NetworkCidr = "string",
  RemoteIpv4NetworkCidr = "string",
  LocalIpv6NetworkCidr = "string",
  RemoteIpv6NetworkCidr = "string",
  DryRun = TRUE|FALSE
)