AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) ModifyVpnTunnelOptions API operation.

Syntax

Edit-EC2VpnTunnelOption
-VpnConnectionId <String>
-CloudWatchLogOptions_BgpLogEnabled <Boolean>
-CloudWatchLogOptions_BgpLogGroupArn <String>
-CloudWatchLogOptions_BgpLogOutputFormat <String>
-TunnelOptions_DPDTimeoutAction <String>
-TunnelOptions_DPDTimeoutSecond <Int32>
-DryRun <Boolean>
-TunnelOptions_EnableTunnelLifecycleControl <Boolean>
-TunnelOptions_IKEVersion <IKEVersionsRequestListValue[]>
-CloudWatchLogOptions_LogEnabled <Boolean>
-CloudWatchLogOptions_LogGroupArn <String>
-CloudWatchLogOptions_LogOutputFormat <String>
-TunnelOptions_Phase1DHGroupNumber <Phase1DHGroupNumbersRequestListValue[]>
-TunnelOptions_Phase1EncryptionAlgorithm <Phase1EncryptionAlgorithmsRequestListValue[]>
-TunnelOptions_Phase1IntegrityAlgorithm <Phase1IntegrityAlgorithmsRequestListValue[]>
-TunnelOptions_Phase1LifetimeSecond <Int32>
-TunnelOptions_Phase2DHGroupNumber <Phase2DHGroupNumbersRequestListValue[]>
-TunnelOptions_Phase2EncryptionAlgorithm <Phase2EncryptionAlgorithmsRequestListValue[]>
-TunnelOptions_Phase2IntegrityAlgorithm <Phase2IntegrityAlgorithmsRequestListValue[]>
-TunnelOptions_Phase2LifetimeSecond <Int32>
-TunnelOptions_PreSharedKey <String>
-PreSharedKeyStorage <String>
-TunnelOptions_RekeyFuzzPercentage <Int32>
-TunnelOptions_RekeyMarginTimeSecond <Int32>
-TunnelOptions_ReplayWindowSize <Int32>
-SkipTunnelReplacement <Boolean>
-TunnelOptions_StartupAction <String>
-TunnelOptions_TunnelInsideCidr <String>
-TunnelOptions_TunnelInsideIpv6Cidr <String>
-VpnTunnelOutsideIpAddress <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

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.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchLogOptions_BgpLogEnabled <Boolean>
Specifies whether to enable BGP logging for the VPN connection. Default value is False.Valid values: True | False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_BgpLogEnabled
-CloudWatchLogOptions_BgpLogGroupArn <String>
The Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_BgpLogGroupArn
-CloudWatchLogOptions_BgpLogOutputFormat <String>
The desired output format for BGP logs to be sent to CloudWatch. Default format is json.Valid values: json | text
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_BgpLogOutputFormat
-CloudWatchLogOptions_LogEnabled <Boolean>
Enable or disable VPN tunnel logging feature. Default value is False.Valid values: True | False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_LogEnabled
-CloudWatchLogOptions_LogGroupArn <String>
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_LogGroupArn
-CloudWatchLogOptions_LogOutputFormat <String>
Set log format. Default format is json.Valid values: json | text
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_LogOptions_CloudWatchLogOptions_LogOutputFormat
-DryRun <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreSharedKeyStorage <String>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'VpnConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyVpnTunnelOptionsResponse). Specifying the name of a property of type Amazon.EC2.Model.ModifyVpnTunnelOptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SkipTunnelReplacement <Boolean>
Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off EnableTunnelLifecycleControl.Valid values: True | False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_DPDTimeoutAction <String>
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.Valid Values: clear | none | restartDefault: clear
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_DPDTimeoutSecond <Int32>
The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.Constraints: A value greater than or equal to 30.Default: 40
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_DPDTimeoutSeconds
-TunnelOptions_EnableTunnelLifecycleControl <Boolean>
Turn on or off tunnel endpoint lifecycle control feature.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_IKEVersion <IKEVersionsRequestListValue[]>
The IKE versions that are permitted for the VPN tunnel.Valid values: ikev1 | ikev2 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_IKEVersions
-TunnelOptions_Phase1DHGroupNumber <Phase1DHGroupNumbersRequestListValue[]>
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase1DHGroupNumbers
-TunnelOptions_Phase1EncryptionAlgorithm <Phase1EncryptionAlgorithmsRequestListValue[]>
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase1EncryptionAlgorithms
-TunnelOptions_Phase1IntegrityAlgorithm <Phase1IntegrityAlgorithmsRequestListValue[]>
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase1IntegrityAlgorithms
-TunnelOptions_Phase1LifetimeSecond <Int32>
The lifetime for phase 1 of the IKE negotiation, in seconds.Constraints: A value between 900 and 28,800.Default: 28800
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase1LifetimeSeconds
-TunnelOptions_Phase2DHGroupNumber <Phase2DHGroupNumbersRequestListValue[]>
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase2DHGroupNumbers
-TunnelOptions_Phase2EncryptionAlgorithm <Phase2EncryptionAlgorithmsRequestListValue[]>
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase2EncryptionAlgorithms
-TunnelOptions_Phase2IntegrityAlgorithm <Phase2IntegrityAlgorithmsRequestListValue[]>
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase2IntegrityAlgorithms
-TunnelOptions_Phase2LifetimeSecond <Int32>
The lifetime for phase 2 of the IKE negotiation, in seconds.Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.Default: 3600
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_Phase2LifetimeSeconds
-TunnelOptions_PreSharedKey <String>
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_RekeyFuzzPercentage <Int32>
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.Constraints: A value between 0 and 100.Default: 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_RekeyMarginTimeSecond <Int32>
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.Constraints: A value between 60 and half of Phase2LifetimeSeconds.Default: 270
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTunnelOptions_RekeyMarginTimeSeconds
-TunnelOptions_ReplayWindowSize <Int32>
The number of packets in an IKE replay window.Constraints: A value between 64 and 2048.Default: 1024
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_StartupAction <String>
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.Valid Values: add | startDefault: add
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_TunnelInsideCidr <String>
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
  • 169.254.0.0/30
  • 169.254.1.0/30
  • 169.254.2.0/30
  • 169.254.3.0/30
  • 169.254.4.0/30
  • 169.254.5.0/30
  • 169.254.169.252/30
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TunnelOptions_TunnelInsideIpv6Cidr <String>
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.Constraints: A size /126 CIDR block from the local fd00::/8 range.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpnConnectionId <String>
The ID of the Amazon Web Services Site-to-Site VPN connection.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-VpnTunnelOutsideIpAddress <String>
The external IP address of the VPN tunnel.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.VpnConnection or Amazon.EC2.Model.ModifyVpnTunnelOptionsResponse
This cmdlet returns an Amazon.EC2.Model.VpnConnection object. The service call response (type Amazon.EC2.Model.ModifyVpnTunnelOptionsResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z