Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
Synopsis
- data ModifyClientVpnEndpoint = ModifyClientVpnEndpoint' {
- clientConnectOptions :: Maybe ClientConnectOptions
- clientLoginBannerOptions :: Maybe ClientLoginBannerOptions
- connectionLogOptions :: Maybe ConnectionLogOptions
- description :: Maybe Text
- dnsServers :: Maybe DnsServersOptionsModifyStructure
- dryRun :: Maybe Bool
- securityGroupIds :: Maybe [Text]
- selfServicePortal :: Maybe SelfServicePortal
- serverCertificateArn :: Maybe Text
- sessionTimeoutHours :: Maybe Int
- splitTunnel :: Maybe Bool
- vpcId :: Maybe Text
- vpnPort :: Maybe Int
- clientVpnEndpointId :: Text
- newModifyClientVpnEndpoint :: Text -> ModifyClientVpnEndpoint
- modifyClientVpnEndpoint_clientConnectOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientConnectOptions)
- modifyClientVpnEndpoint_clientLoginBannerOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientLoginBannerOptions)
- modifyClientVpnEndpoint_connectionLogOptions :: Lens' ModifyClientVpnEndpoint (Maybe ConnectionLogOptions)
- modifyClientVpnEndpoint_description :: Lens' ModifyClientVpnEndpoint (Maybe Text)
- modifyClientVpnEndpoint_dnsServers :: Lens' ModifyClientVpnEndpoint (Maybe DnsServersOptionsModifyStructure)
- modifyClientVpnEndpoint_dryRun :: Lens' ModifyClientVpnEndpoint (Maybe Bool)
- modifyClientVpnEndpoint_securityGroupIds :: Lens' ModifyClientVpnEndpoint (Maybe [Text])
- modifyClientVpnEndpoint_selfServicePortal :: Lens' ModifyClientVpnEndpoint (Maybe SelfServicePortal)
- modifyClientVpnEndpoint_serverCertificateArn :: Lens' ModifyClientVpnEndpoint (Maybe Text)
- modifyClientVpnEndpoint_sessionTimeoutHours :: Lens' ModifyClientVpnEndpoint (Maybe Int)
- modifyClientVpnEndpoint_splitTunnel :: Lens' ModifyClientVpnEndpoint (Maybe Bool)
- modifyClientVpnEndpoint_vpcId :: Lens' ModifyClientVpnEndpoint (Maybe Text)
- modifyClientVpnEndpoint_vpnPort :: Lens' ModifyClientVpnEndpoint (Maybe Int)
- modifyClientVpnEndpoint_clientVpnEndpointId :: Lens' ModifyClientVpnEndpoint Text
- data ModifyClientVpnEndpointResponse = ModifyClientVpnEndpointResponse' {
- return' :: Maybe Bool
- httpStatus :: Int
- newModifyClientVpnEndpointResponse :: Int -> ModifyClientVpnEndpointResponse
- modifyClientVpnEndpointResponse_return :: Lens' ModifyClientVpnEndpointResponse (Maybe Bool)
- modifyClientVpnEndpointResponse_httpStatus :: Lens' ModifyClientVpnEndpointResponse Int
Creating a Request
data ModifyClientVpnEndpoint Source #
See: newModifyClientVpnEndpoint
smart constructor.
ModifyClientVpnEndpoint' | |
|
Instances
newModifyClientVpnEndpoint Source #
Create a value of ModifyClientVpnEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_clientConnectOptions
- The options for managing connection authorization for new client
connections.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_clientLoginBannerOptions
- Options for enabling a customizable text banner that will be displayed
on Amazon Web Services provided clients when a VPN session is
established.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_connectionLogOptions
- Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
- Client connection requests
- Client connection results (successful and unsuccessful)
- Reasons for unsuccessful client connection requests
- Client connection termination time
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_description
- A brief description of the Client VPN endpoint.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_dnsServers
- Information about the DNS servers to be used by Client VPN connections.
A Client VPN endpoint can have up to two DNS servers.
$sel:dryRun:ModifyClientVpnEndpoint'
, modifyClientVpnEndpoint_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
.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_securityGroupIds
- The IDs of one or more security groups to apply to the target network.
$sel:selfServicePortal:ModifyClientVpnEndpoint'
, modifyClientVpnEndpoint_selfServicePortal
- Specify whether to enable the self-service portal for the Client VPN
endpoint.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_serverCertificateArn
- The ARN of the server certificate to be used. The server certificate
must be provisioned in Certificate Manager (ACM).
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_sessionTimeoutHours
- The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_splitTunnel
- 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.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_vpcId
- The ID of the VPC to associate with the Client VPN endpoint.
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_vpnPort
- The port number to assign to the Client VPN endpoint for TCP and UDP
traffic.
Valid Values: 443
| 1194
Default Value: 443
ModifyClientVpnEndpoint
, modifyClientVpnEndpoint_clientVpnEndpointId
- The ID of the Client VPN endpoint to modify.
Request Lenses
modifyClientVpnEndpoint_clientConnectOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientConnectOptions) Source #
The options for managing connection authorization for new client connections.
modifyClientVpnEndpoint_clientLoginBannerOptions :: Lens' ModifyClientVpnEndpoint (Maybe ClientLoginBannerOptions) Source #
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
modifyClientVpnEndpoint_connectionLogOptions :: Lens' ModifyClientVpnEndpoint (Maybe ConnectionLogOptions) Source #
Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
- Client connection requests
- Client connection results (successful and unsuccessful)
- Reasons for unsuccessful client connection requests
- Client connection termination time
modifyClientVpnEndpoint_description :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #
A brief description of the Client VPN endpoint.
modifyClientVpnEndpoint_dnsServers :: Lens' ModifyClientVpnEndpoint (Maybe DnsServersOptionsModifyStructure) Source #
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
modifyClientVpnEndpoint_dryRun :: Lens' ModifyClientVpnEndpoint (Maybe Bool) Source #
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
.
modifyClientVpnEndpoint_securityGroupIds :: Lens' ModifyClientVpnEndpoint (Maybe [Text]) Source #
The IDs of one or more security groups to apply to the target network.
modifyClientVpnEndpoint_selfServicePortal :: Lens' ModifyClientVpnEndpoint (Maybe SelfServicePortal) Source #
Specify whether to enable the self-service portal for the Client VPN endpoint.
modifyClientVpnEndpoint_serverCertificateArn :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #
The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
modifyClientVpnEndpoint_sessionTimeoutHours :: Lens' ModifyClientVpnEndpoint (Maybe Int) Source #
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
modifyClientVpnEndpoint_splitTunnel :: Lens' ModifyClientVpnEndpoint (Maybe Bool) Source #
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.
modifyClientVpnEndpoint_vpcId :: Lens' ModifyClientVpnEndpoint (Maybe Text) Source #
The ID of the VPC to associate with the Client VPN endpoint.
modifyClientVpnEndpoint_vpnPort :: Lens' ModifyClientVpnEndpoint (Maybe Int) Source #
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443
| 1194
Default Value: 443
modifyClientVpnEndpoint_clientVpnEndpointId :: Lens' ModifyClientVpnEndpoint Text Source #
The ID of the Client VPN endpoint to modify.
Destructuring the Response
data ModifyClientVpnEndpointResponse Source #
See: newModifyClientVpnEndpointResponse
smart constructor.
ModifyClientVpnEndpointResponse' | |
|
Instances
Generic ModifyClientVpnEndpointResponse Source # | |
Read ModifyClientVpnEndpointResponse Source # | |
Show ModifyClientVpnEndpointResponse Source # | |
Defined in Amazonka.EC2.ModifyClientVpnEndpoint | |
NFData ModifyClientVpnEndpointResponse Source # | |
Defined in Amazonka.EC2.ModifyClientVpnEndpoint rnf :: ModifyClientVpnEndpointResponse -> () # | |
Eq ModifyClientVpnEndpointResponse Source # | |
type Rep ModifyClientVpnEndpointResponse Source # | |
Defined in Amazonka.EC2.ModifyClientVpnEndpoint type Rep ModifyClientVpnEndpointResponse = D1 ('MetaData "ModifyClientVpnEndpointResponse" "Amazonka.EC2.ModifyClientVpnEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyClientVpnEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "return'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newModifyClientVpnEndpointResponse Source #
Create a value of ModifyClientVpnEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:return':ModifyClientVpnEndpointResponse'
, modifyClientVpnEndpointResponse_return
- Returns true
if the request succeeds; otherwise, it returns an error.
$sel:httpStatus:ModifyClientVpnEndpointResponse'
, modifyClientVpnEndpointResponse_httpStatus
- The response's http status code.
Response Lenses
modifyClientVpnEndpointResponse_return :: Lens' ModifyClientVpnEndpointResponse (Maybe Bool) Source #
Returns true
if the request succeeds; otherwise, it returns an error.
modifyClientVpnEndpointResponse_httpStatus :: Lens' ModifyClientVpnEndpointResponse Int Source #
The response's http status code.