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) ModifyClientVpnEndpoint API operation.

Syntax

Edit-EC2ClientVpnEndpoint
-ClientVpnEndpointId <String>
-ClientLoginBannerOptions_BannerText <String>
-ConnectionLogOptions_CloudwatchLogGroup <String>
-ConnectionLogOptions_CloudwatchLogStream <String>
-DnsServers_CustomDnsServer <String[]>
-Description <String>
-DisconnectOnSessionTimeout <Boolean>
-DryRun <Boolean>
-ClientConnectOptions_Enabled <Boolean>
-ClientLoginBannerOptions_Enabled <Boolean>
-ConnectionLogOptions_Enabled <Boolean>
-DnsServers_Enabled <Boolean>
-ClientRouteEnforcementOptions_Enforced <Boolean>
-ClientConnectOptions_LambdaFunctionArn <String>
-SecurityGroupId <String[]>
-SelfServicePortal <SelfServicePortal>
-ServerCertificateArn <String>
-SessionTimeoutHour <Int32>
-SplitTunnel <Boolean>
-VpcId <String>
-VpnPort <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConnectOptions_Enabled <Boolean>
Indicates whether client connect options are enabled. The default is false (not enabled).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConnectOptions_LambdaFunctionArn <String>
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientLoginBannerOptions_BannerText <String>
Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientLoginBannerOptions_Enabled <Boolean>
Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.Valid values: true | falseDefault value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRouteEnforcementOptions_Enforced <Boolean>
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.Valid values: true | falseDefault value: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientVpnEndpointId <String>
The ID of the Client VPN endpoint to modify.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ConnectionLogOptions_CloudwatchLogGroup <String>
The name of the CloudWatch Logs log group. Required if connection logging is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionLogOptions_CloudwatchLogStream <String>
The name of the CloudWatch Logs log stream to which the connection data is published.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionLogOptions_Enabled <Boolean>
Indicates whether connection logging is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A brief description of the Client VPN endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisconnectOnSessionTimeout <Boolean>
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsServers_CustomDnsServer <String[]>
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values. 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)
AliasesDnsServers_CustomDnsServers
-DnsServers_Enabled <Boolean>
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-SecurityGroupId <String[]>
The IDs of one or more security groups to apply to the target network. 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)
AliasesSecurityGroupIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Return'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyClientVpnEndpointResponse). Specifying the name of a property of type Amazon.EC2.Model.ModifyClientVpnEndpointResponse 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)
-SelfServicePortal <SelfServicePortal>
Specify whether to enable the self-service portal for the Client VPN endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerCertificateArn <String>
The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionTimeoutHour <Int32>
The maximum VPN session duration time in hours.Valid values: 8 | 10 | 12 | 24Default value: 24
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionTimeoutHours
-SplitTunnel <Boolean>
Indicates whether the VPN is split-tunnel.For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcId <String>
The ID of the VPC to associate with the Client VPN endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpnPort <Int32>
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.Valid Values: 443 | 1194Default Value: 443
Required?False
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

System.Boolean or Amazon.EC2.Model.ModifyClientVpnEndpointResponse
This cmdlet returns a collection of System.Boolean objects. The service call response (type Amazon.EC2.Model.ModifyClientVpnEndpointResponse) 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