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 |
Synopsis
- data ClientVpnEndpoint = ClientVpnEndpoint' {
- associatedTargetNetworks :: Maybe [AssociatedTargetNetwork]
- authenticationOptions :: Maybe [ClientVpnAuthentication]
- clientCidrBlock :: Maybe Text
- clientConnectOptions :: Maybe ClientConnectResponseOptions
- clientLoginBannerOptions :: Maybe ClientLoginBannerResponseOptions
- clientVpnEndpointId :: Maybe Text
- connectionLogOptions :: Maybe ConnectionLogResponseOptions
- creationTime :: Maybe Text
- deletionTime :: Maybe Text
- description :: Maybe Text
- dnsName :: Maybe Text
- dnsServers :: Maybe [Text]
- securityGroupIds :: Maybe [Text]
- selfServicePortalUrl :: Maybe Text
- serverCertificateArn :: Maybe Text
- sessionTimeoutHours :: Maybe Int
- splitTunnel :: Maybe Bool
- status :: Maybe ClientVpnEndpointStatus
- tags :: Maybe [Tag]
- transportProtocol :: Maybe TransportProtocol
- vpcId :: Maybe Text
- vpnPort :: Maybe Int
- vpnProtocol :: Maybe VpnProtocol
- newClientVpnEndpoint :: ClientVpnEndpoint
- clientVpnEndpoint_associatedTargetNetworks :: Lens' ClientVpnEndpoint (Maybe [AssociatedTargetNetwork])
- clientVpnEndpoint_authenticationOptions :: Lens' ClientVpnEndpoint (Maybe [ClientVpnAuthentication])
- clientVpnEndpoint_clientCidrBlock :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_clientConnectOptions :: Lens' ClientVpnEndpoint (Maybe ClientConnectResponseOptions)
- clientVpnEndpoint_clientLoginBannerOptions :: Lens' ClientVpnEndpoint (Maybe ClientLoginBannerResponseOptions)
- clientVpnEndpoint_clientVpnEndpointId :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_connectionLogOptions :: Lens' ClientVpnEndpoint (Maybe ConnectionLogResponseOptions)
- clientVpnEndpoint_creationTime :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_deletionTime :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_description :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_dnsName :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_dnsServers :: Lens' ClientVpnEndpoint (Maybe [Text])
- clientVpnEndpoint_securityGroupIds :: Lens' ClientVpnEndpoint (Maybe [Text])
- clientVpnEndpoint_selfServicePortalUrl :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_serverCertificateArn :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_sessionTimeoutHours :: Lens' ClientVpnEndpoint (Maybe Int)
- clientVpnEndpoint_splitTunnel :: Lens' ClientVpnEndpoint (Maybe Bool)
- clientVpnEndpoint_status :: Lens' ClientVpnEndpoint (Maybe ClientVpnEndpointStatus)
- clientVpnEndpoint_tags :: Lens' ClientVpnEndpoint (Maybe [Tag])
- clientVpnEndpoint_transportProtocol :: Lens' ClientVpnEndpoint (Maybe TransportProtocol)
- clientVpnEndpoint_vpcId :: Lens' ClientVpnEndpoint (Maybe Text)
- clientVpnEndpoint_vpnPort :: Lens' ClientVpnEndpoint (Maybe Int)
- clientVpnEndpoint_vpnProtocol :: Lens' ClientVpnEndpoint (Maybe VpnProtocol)
Documentation
data ClientVpnEndpoint Source #
Describes a Client VPN endpoint.
See: newClientVpnEndpoint
smart constructor.
ClientVpnEndpoint' | |
|
Instances
newClientVpnEndpoint :: ClientVpnEndpoint Source #
Create a value of ClientVpnEndpoint
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:associatedTargetNetworks:ClientVpnEndpoint'
, clientVpnEndpoint_associatedTargetNetworks
- Information about the associated target networks. A target network is a
subnet in a VPC.
$sel:authenticationOptions:ClientVpnEndpoint'
, clientVpnEndpoint_authenticationOptions
- Information about the authentication method used by the Client VPN
endpoint.
$sel:clientCidrBlock:ClientVpnEndpoint'
, clientVpnEndpoint_clientCidrBlock
- The IPv4 address range, in CIDR notation, from which client IP addresses
are assigned.
$sel:clientConnectOptions:ClientVpnEndpoint'
, clientVpnEndpoint_clientConnectOptions
- The options for managing connection authorization for new client
connections.
$sel:clientLoginBannerOptions:ClientVpnEndpoint'
, clientVpnEndpoint_clientLoginBannerOptions
- Options for enabling a customizable text banner that will be displayed
on Amazon Web Services provided clients when a VPN session is
established.
$sel:clientVpnEndpointId:ClientVpnEndpoint'
, clientVpnEndpoint_clientVpnEndpointId
- The ID of the Client VPN endpoint.
$sel:connectionLogOptions:ClientVpnEndpoint'
, clientVpnEndpoint_connectionLogOptions
- Information about the client connection logging options for the Client
VPN endpoint.
$sel:creationTime:ClientVpnEndpoint'
, clientVpnEndpoint_creationTime
- The date and time the Client VPN endpoint was created.
$sel:deletionTime:ClientVpnEndpoint'
, clientVpnEndpoint_deletionTime
- The date and time the Client VPN endpoint was deleted, if applicable.
$sel:description:ClientVpnEndpoint'
, clientVpnEndpoint_description
- A brief description of the endpoint.
$sel:dnsName:ClientVpnEndpoint'
, clientVpnEndpoint_dnsName
- The DNS name to be used by clients when connecting to the Client VPN
endpoint.
$sel:dnsServers:ClientVpnEndpoint'
, clientVpnEndpoint_dnsServers
- Information about the DNS servers to be used for DNS resolution.
$sel:securityGroupIds:ClientVpnEndpoint'
, clientVpnEndpoint_securityGroupIds
- The IDs of the security groups for the target network.
$sel:selfServicePortalUrl:ClientVpnEndpoint'
, clientVpnEndpoint_selfServicePortalUrl
- The URL of the self-service portal.
$sel:serverCertificateArn:ClientVpnEndpoint'
, clientVpnEndpoint_serverCertificateArn
- The ARN of the server certificate.
$sel:sessionTimeoutHours:ClientVpnEndpoint'
, clientVpnEndpoint_sessionTimeoutHours
- The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
$sel:splitTunnel:ClientVpnEndpoint'
, clientVpnEndpoint_splitTunnel
- Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
ClientVpnEndpoint
, clientVpnEndpoint_status
- The current state of the Client VPN endpoint.
$sel:tags:ClientVpnEndpoint'
, clientVpnEndpoint_tags
- Any tags assigned to the Client VPN endpoint.
$sel:transportProtocol:ClientVpnEndpoint'
, clientVpnEndpoint_transportProtocol
- The transport protocol used by the Client VPN endpoint.
$sel:vpcId:ClientVpnEndpoint'
, clientVpnEndpoint_vpcId
- The ID of the VPC.
$sel:vpnPort:ClientVpnEndpoint'
, clientVpnEndpoint_vpnPort
- The port number for the Client VPN endpoint.
$sel:vpnProtocol:ClientVpnEndpoint'
, clientVpnEndpoint_vpnProtocol
- The protocol used by the VPN session.
clientVpnEndpoint_associatedTargetNetworks :: Lens' ClientVpnEndpoint (Maybe [AssociatedTargetNetwork]) Source #
Information about the associated target networks. A target network is a subnet in a VPC.
clientVpnEndpoint_authenticationOptions :: Lens' ClientVpnEndpoint (Maybe [ClientVpnAuthentication]) Source #
Information about the authentication method used by the Client VPN endpoint.
clientVpnEndpoint_clientCidrBlock :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
clientVpnEndpoint_clientConnectOptions :: Lens' ClientVpnEndpoint (Maybe ClientConnectResponseOptions) Source #
The options for managing connection authorization for new client connections.
clientVpnEndpoint_clientLoginBannerOptions :: Lens' ClientVpnEndpoint (Maybe ClientLoginBannerResponseOptions) Source #
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
clientVpnEndpoint_clientVpnEndpointId :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The ID of the Client VPN endpoint.
clientVpnEndpoint_connectionLogOptions :: Lens' ClientVpnEndpoint (Maybe ConnectionLogResponseOptions) Source #
Information about the client connection logging options for the Client VPN endpoint.
clientVpnEndpoint_creationTime :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The date and time the Client VPN endpoint was created.
clientVpnEndpoint_deletionTime :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The date and time the Client VPN endpoint was deleted, if applicable.
clientVpnEndpoint_description :: Lens' ClientVpnEndpoint (Maybe Text) Source #
A brief description of the endpoint.
clientVpnEndpoint_dnsName :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The DNS name to be used by clients when connecting to the Client VPN endpoint.
clientVpnEndpoint_dnsServers :: Lens' ClientVpnEndpoint (Maybe [Text]) Source #
Information about the DNS servers to be used for DNS resolution.
clientVpnEndpoint_securityGroupIds :: Lens' ClientVpnEndpoint (Maybe [Text]) Source #
The IDs of the security groups for the target network.
clientVpnEndpoint_selfServicePortalUrl :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The URL of the self-service portal.
clientVpnEndpoint_serverCertificateArn :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The ARN of the server certificate.
clientVpnEndpoint_sessionTimeoutHours :: Lens' ClientVpnEndpoint (Maybe Int) Source #
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
clientVpnEndpoint_splitTunnel :: Lens' ClientVpnEndpoint (Maybe Bool) Source #
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
clientVpnEndpoint_status :: Lens' ClientVpnEndpoint (Maybe ClientVpnEndpointStatus) Source #
The current state of the Client VPN endpoint.
clientVpnEndpoint_tags :: Lens' ClientVpnEndpoint (Maybe [Tag]) Source #
Any tags assigned to the Client VPN endpoint.
clientVpnEndpoint_transportProtocol :: Lens' ClientVpnEndpoint (Maybe TransportProtocol) Source #
The transport protocol used by the Client VPN endpoint.
clientVpnEndpoint_vpcId :: Lens' ClientVpnEndpoint (Maybe Text) Source #
The ID of the VPC.
clientVpnEndpoint_vpnPort :: Lens' ClientVpnEndpoint (Maybe Int) Source #
The port number for the Client VPN endpoint.
clientVpnEndpoint_vpnProtocol :: Lens' ClientVpnEndpoint (Maybe VpnProtocol) Source #
The protocol used by the VPN session.