EndpointArgs class

The set of arguments for Endpoint. The set of arguments for Endpoint.

Constructors

EndpointArgs({required Input<List<EndpointAuthenticationOption>> authenticationOptions, Input<String?>? clientCidrBlock, Input<EndpointClientConnectOptions?>? clientConnectOptions, Input<EndpointClientLoginBannerOptions?>? clientLoginBannerOptions, Input<EndpointClientRouteEnforcementOptions?>? clientRouteEnforcementOptions, required Input<EndpointConnectionLogOptions> connectionLogOptions, Input<String?>? description, Input<bool?>? disconnectOnSessionTimeout, Input<List<String>?>? dnsServers, Input<String?>? endpointIpAddressType, Input<String?>? region, Input<List<String>?>? securityGroupIds, Input<String?>? selfServicePortal, required Input<String> serverCertificateArn, Input<int?>? sessionTimeoutHours, Input<bool?>? splitTunnel, Input<Map<String, String>?>? tags, Input<String?>? trafficIpAddressType, Input<EndpointTransitGatewayConfiguration?>? transitGatewayConfiguration, Input<String?>? transportProtocol, Input<String?>? vpcId, Input<int?>? vpnPort})
Creates a new EndpointArgs. authenticationOptions Information about the authentication method to be used to authenticate clients. See authenticationOptions Block Reference below for details. clientCidrBlock The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. When trafficIpAddressType is set to ipv6, it must not be specified. Otherwise, it is required. clientConnectOptions The options for managing connection authorization for new client connections. See clientConnectOptions Block Reference below for details. clientLoginBannerOptions Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. See clientLoginBannerOptions Block Reference below for details. clientRouteEnforcementOptions Options for enforce administrator defined routes on devices connected through the VPN. See clientRouteEnforcementOptions Block Reference below for details. connectionLogOptions Information about the client connection logging options. See connectionLogOptions Block Reference below for details. description A brief description of the Client VPN endpoint. disconnectOnSessionTimeout Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false. dnsServers Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used. endpointIpAddressType IP address type for the Client VPN endpoint. Valid values are ipv4, ipv6, or dual-stack. Defaults to ipv4. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. securityGroupIds The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. Conflicts with transitGatewayConfiguration. selfServicePortal Specify whether to enable the self-service portal for the Client VPN endpoint. Values can be enabled or disabled. Default value is disabled. serverCertificateArn The ARN of the ACM server certificate. sessionTimeoutHours The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is 24 - Valid values: 8 | 10 | 12 | 24 splitTunnel Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false. tags A mapping of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. trafficIpAddressType IP address type for traffic within the Client VPN tunnel. Valid values are ipv4, ipv6, or dual-stack. Defaults to ipv4. When it is set to ipv6, clientCidrBlock must not be specified. transitGatewayConfiguration Configuration block for associating the Client VPN endpoint with a Transit Gateway. Conflicts with vpcId and securityGroupIds. See transitGatewayConfiguration Block Reference below for details. transportProtocol The transport protocol to be used by the VPN session. Default value is udp. vpcId The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. Conflicts with transitGatewayConfiguration. vpnPort The port number for the Client VPN endpoint. Valid values are 443 and 1194. Default value is 443.
const
EndpointArgs.fromMap(Map<String, dynamic> map)
factory

Properties

authenticationOptions → Input<List<EndpointAuthenticationOption>>
Information about the authentication method to be used to authenticate clients. See authenticationOptions Block Reference below for details.
final
clientCidrBlock → Input<String?>?
The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. When trafficIpAddressType is set to ipv6, it must not be specified. Otherwise, it is required.
final
clientConnectOptions → Input<EndpointClientConnectOptions?>?
The options for managing connection authorization for new client connections. See clientConnectOptions Block Reference below for details.
final
clientLoginBannerOptions → Input<EndpointClientLoginBannerOptions?>?
Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. See clientLoginBannerOptions Block Reference below for details.
final
clientRouteEnforcementOptions → Input<EndpointClientRouteEnforcementOptions?>?
Options for enforce administrator defined routes on devices connected through the VPN. See clientRouteEnforcementOptions Block Reference below for details.
final
connectionLogOptions → Input<EndpointConnectionLogOptions>
Information about the client connection logging options. See connectionLogOptions Block Reference below for details.
final
description → Input<String?>?
A brief description of the Client VPN endpoint.
final
disconnectOnSessionTimeout → Input<bool?>?
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
final
dnsServers → Input<List<String>?>?
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used.
final
endpointIpAddressType → Input<String?>?
IP address type for the Client VPN endpoint. Valid values are ipv4, ipv6, or dual-stack. Defaults to ipv4.
final
hashCode → int
The hash code for this object.
no setterinherited
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. Conflicts with transitGatewayConfiguration.
final
selfServicePortal → Input<String?>?
Specify whether to enable the self-service portal for the Client VPN endpoint. Values can be enabled or disabled. Default value is disabled.
final
serverCertificateArn → Input<String>
The ARN of the ACM server certificate.
final
sessionTimeoutHours → Input<int?>?
The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is 24 - Valid values: 8 | 10 | 12 | 24
final
splitTunnel → Input<bool?>?
Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.
final
tags → Input<Map<String, String>?>?
A mapping of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
trafficIpAddressType → Input<String?>?
IP address type for traffic within the Client VPN tunnel. Valid values are ipv4, ipv6, or dual-stack. Defaults to ipv4. When it is set to ipv6, clientCidrBlock must not be specified.
final
transitGatewayConfiguration → Input<EndpointTransitGatewayConfiguration?>?
Configuration block for associating the Client VPN endpoint with a Transit Gateway. Conflicts with vpcId and securityGroupIds. See transitGatewayConfiguration Block Reference below for details.
final
transportProtocol → Input<String?>?
The transport protocol to be used by the VPN session. Default value is udp.
final
vpcId → Input<String?>?
The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. Conflicts with transitGatewayConfiguration.
final
vpnPort → Input<int?>?
The port number for the Client VPN endpoint. Valid values are 443 and 1194. Default value is 443.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited