Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection¶

Description¶

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

Usage¶

ec2_modify_vpn_tunnel_options(VpnConnectionId,
  VpnTunnelOutsideIpAddress, TunnelOptions, DryRun, SkipTunnelReplacement,
  PreSharedKeyStorage)

Arguments¶

VpnConnectionId

[required] The ID of the Amazon Web Services Site-to-Site VPN connection.
VpnTunnelOutsideIpAddress

[required] The external IP address of the VPN tunnel.
TunnelOptions

[required] The tunnel options to modify.
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.
SkipTunnelReplacement

Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off EnableTunnelLifecycleControl.

Valid values: True | False
PreSharedKeyStorage

Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard (stored in Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).

Value¶

A list with the following syntax:

list(
  VpnConnection = list(
    Category = "string",
    TransitGatewayId = "string",
    VpnConcentratorId = "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",
              BgpLogEnabled = TRUE|FALSE,
              BgpLogGroupArn = "string",
              BgpLogOutputFormat = "string"
            )
          ),
          EnableTunnelLifecycleControl = TRUE|FALSE
        )
      ),
      TunnelBandwidth = "standard"|"large"
    ),
    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"
      )
    ),
    PreSharedKeyArn = "string",
    VpnConnectionId = "string",
    State = "pending"|"available"|"deleting"|"deleted",
    CustomerGatewayConfiguration = "string",
    Type = "ipsec.1",
    CustomerGatewayId = "string",
    VpnGatewayId = "string"
  )
)

Request syntax¶

svc$modify_vpn_tunnel_options(
  VpnConnectionId = "string",
  VpnTunnelOutsideIpAddress = "string",
  TunnelOptions = list(
    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",
        BgpLogEnabled = TRUE|FALSE,
        BgpLogGroupArn = "string",
        BgpLogOutputFormat = "string"
      )
    ),
    EnableTunnelLifecycleControl = TRUE|FALSE
  ),
  DryRun = TRUE|FALSE,
  SkipTunnelReplacement = TRUE|FALSE,
  PreSharedKeyStorage = "string"
)