Amazonka.EC2.Types.ClientVpnEndpoint

Documentation

data ClientVpnEndpoint

Describes a Client VPN endpoint.

See: newClientVpnEndpoint smart constructor.

Constructors

ClientVpnEndpoint'

Fields

• associatedTargetNetworks :: Maybe [AssociatedTargetNetwork]

  Information about the associated target networks. A target network is a subnet in a VPC.

• authenticationOptions :: Maybe [ClientVpnAuthentication]

  Information about the authentication method used by the Client VPN endpoint.

• clientCidrBlock :: Maybe Text

  The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

• clientConnectOptions :: Maybe ClientConnectResponseOptions

  The options for managing connection authorization for new client connections.

• clientLoginBannerOptions :: Maybe ClientLoginBannerResponseOptions

  Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

• clientVpnEndpointId :: Maybe Text

  The ID of the Client VPN endpoint.

• connectionLogOptions :: Maybe ConnectionLogResponseOptions

  Information about the client connection logging options for the Client VPN endpoint.

• creationTime :: Maybe Text

  The date and time the Client VPN endpoint was created.

• deletionTime :: Maybe Text

  The date and time the Client VPN endpoint was deleted, if applicable.

• description :: Maybe Text

  A brief description of the endpoint.

• dnsName :: Maybe Text

  The DNS name to be used by clients when connecting to the Client VPN endpoint.

• dnsServers :: Maybe [Text]

  Information about the DNS servers to be used for DNS resolution.

• securityGroupIds :: Maybe [Text]

  The IDs of the security groups for the target network.

• selfServicePortalUrl :: Maybe Text

  The URL of the self-service portal.

• serverCertificateArn :: Maybe Text

  The ARN of the server certificate.

• sessionTimeoutHours :: Maybe Int

  The maximum VPN session duration time in hours.

  Valid values: 8 | 10 | 12 | 24

  Default value: 24

• splitTunnel :: Maybe Bool

  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.

• status :: Maybe ClientVpnEndpointStatus

  The current state of the Client VPN endpoint.

• tags :: Maybe [Tag]

  Any tags assigned to the Client VPN endpoint.

• transportProtocol :: Maybe TransportProtocol

  The transport protocol used by the Client VPN endpoint.

• vpcId :: Maybe Text

  The ID of the VPC.

• vpnPort :: Maybe Int

  The port number for the Client VPN endpoint.

• vpnProtocol :: Maybe VpnProtocol

  The protocol used by the VPN session.

Instances

FromXML ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

parseXML :: [Node] -> Either String ClientVpnEndpoint

Generic ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Associated Types

type Rep ClientVpnEndpoint :: Type -> Type

Methods

from :: ClientVpnEndpoint -> Rep ClientVpnEndpoint x

to :: Rep ClientVpnEndpoint x -> ClientVpnEndpoint

Read ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

readsPrec :: Int -> ReadS ClientVpnEndpoint

readList :: ReadS [ClientVpnEndpoint]

readPrec :: ReadPrec ClientVpnEndpoint

readListPrec :: ReadPrec [ClientVpnEndpoint]

Show ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

showsPrec :: Int -> ClientVpnEndpoint -> ShowS

show :: ClientVpnEndpoint -> String

showList :: [ClientVpnEndpoint] -> ShowS

NFData ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

rnf :: ClientVpnEndpoint -> ()

Eq ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

(==) :: ClientVpnEndpoint -> ClientVpnEndpoint -> Bool

(/=) :: ClientVpnEndpoint -> ClientVpnEndpoint -> Bool

Hashable ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

Methods

hashWithSalt :: Int -> ClientVpnEndpoint -> Int

hash :: ClientVpnEndpoint -> Int

type Rep ClientVpnEndpoint

Defined in Amazonka.EC2.Types.ClientVpnEndpoint

type Rep ClientVpnEndpoint = D1 ('MetaData "ClientVpnEndpoint" "Amazonka.EC2.Types.ClientVpnEndpoint" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ClientVpnEndpoint'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "associatedTargetNetworks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssociatedTargetNetwork])) :*: S1 ('MetaSel ('Just "authenticationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientVpnAuthentication]))) :*: (S1 ('MetaSel ('Just "clientCidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientConnectOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientConnectResponseOptions)) :*: S1 ('MetaSel ('Just "clientLoginBannerOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientLoginBannerResponseOptions))))) :*: ((S1 ('MetaSel ('Just "clientVpnEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "connectionLogOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionLogResponseOptions)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "deletionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dnsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "dnsServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "selfServicePortalUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "serverCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sessionTimeoutHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "splitTunnel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientVpnEndpointStatus)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "transportProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransportProtocol)))) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpnPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "vpnProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpnProtocol))))))))

newClientVpnEndpoint :: ClientVpnEndpoint

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])

Information about the associated target networks. A target network is a subnet in a VPC.

clientVpnEndpoint_authenticationOptions :: Lens' ClientVpnEndpoint (Maybe [ClientVpnAuthentication])

Information about the authentication method used by the Client VPN endpoint.

clientVpnEndpoint_clientCidrBlock :: Lens' ClientVpnEndpoint (Maybe Text)

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

clientVpnEndpoint_clientConnectOptions :: Lens' ClientVpnEndpoint (Maybe ClientConnectResponseOptions)

The options for managing connection authorization for new client connections.

clientVpnEndpoint_clientLoginBannerOptions :: Lens' ClientVpnEndpoint (Maybe ClientLoginBannerResponseOptions)

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)

The ID of the Client VPN endpoint.

clientVpnEndpoint_connectionLogOptions :: Lens' ClientVpnEndpoint (Maybe ConnectionLogResponseOptions)

Information about the client connection logging options for the Client VPN endpoint.

clientVpnEndpoint_creationTime :: Lens' ClientVpnEndpoint (Maybe Text)

The date and time the Client VPN endpoint was created.

clientVpnEndpoint_deletionTime :: Lens' ClientVpnEndpoint (Maybe Text)

The date and time the Client VPN endpoint was deleted, if applicable.

clientVpnEndpoint_description :: Lens' ClientVpnEndpoint (Maybe Text)

A brief description of the endpoint.

clientVpnEndpoint_dnsName :: Lens' ClientVpnEndpoint (Maybe Text)

The DNS name to be used by clients when connecting to the Client VPN endpoint.

clientVpnEndpoint_dnsServers :: Lens' ClientVpnEndpoint (Maybe [Text])

Information about the DNS servers to be used for DNS resolution.

clientVpnEndpoint_securityGroupIds :: Lens' ClientVpnEndpoint (Maybe [Text])

The IDs of the security groups for the target network.

clientVpnEndpoint_selfServicePortalUrl :: Lens' ClientVpnEndpoint (Maybe Text)

The URL of the self-service portal.

clientVpnEndpoint_serverCertificateArn :: Lens' ClientVpnEndpoint (Maybe Text)

The ARN of the server certificate.

clientVpnEndpoint_sessionTimeoutHours :: Lens' ClientVpnEndpoint (Maybe Int)

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

clientVpnEndpoint_splitTunnel :: Lens' ClientVpnEndpoint (Maybe Bool)

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)

The current state of the Client VPN endpoint.

clientVpnEndpoint_tags :: Lens' ClientVpnEndpoint (Maybe [Tag])

Any tags assigned to the Client VPN endpoint.

clientVpnEndpoint_transportProtocol :: Lens' ClientVpnEndpoint (Maybe TransportProtocol)

The transport protocol used by the Client VPN endpoint.

clientVpnEndpoint_vpcId :: Lens' ClientVpnEndpoint (Maybe Text)

The ID of the VPC.

clientVpnEndpoint_vpnPort :: Lens' ClientVpnEndpoint (Maybe Int)

The port number for the Client VPN endpoint.

clientVpnEndpoint_vpnProtocol :: Lens' ClientVpnEndpoint (Maybe VpnProtocol)

The protocol used by the VPN session.