EndpointState class
Input properties used for looking up and filtering Endpoint resources.
Constructors
-
EndpointState({Input<
String?> ? arn, Input<List< ? authenticationOptions, Input<EndpointAuthenticationOption> ?>String?> ? clientCidrBlock, Input<EndpointClientConnectOptions?> ? clientConnectOptions, Input<EndpointClientLoginBannerOptions?> ? clientLoginBannerOptions, Input<EndpointClientRouteEnforcementOptions?> ? clientRouteEnforcementOptions, Input<EndpointConnectionLogOptions?> ? connectionLogOptions, Input<String?> ? description, Input<bool?> ? disconnectOnSessionTimeout, Input<String?> ? dnsName, Input<List< ? dnsServers, Input<String> ?>String?> ? endpointIpAddressType, Input<String?> ? region, Input<List< ? securityGroupIds, Input<String> ?>String?> ? selfServicePortal, Input<String?> ? selfServicePortalUrl, Input<String?> ? serverCertificateArn, Input<int?> ? sessionTimeoutHours, Input<bool?> ? splitTunnel, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? trafficIpAddressType, Input<EndpointTransitGatewayConfiguration?> ? transitGatewayConfiguration, Input<String?> ? transportProtocol, Input<String?> ? vpcId, Input<int?> ? vpnPort}) -
Creates a new EndpointState.
arnThe ARN of the Client VPN endpoint.authenticationOptionsInformation about the authentication method to be used to authenticate clients. SeeauthenticationOptionsBlock Reference below for details.clientCidrBlockThe 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. WhentrafficIpAddressTypeis set toipv6, it must not be specified. Otherwise, it is required.clientConnectOptionsThe options for managing connection authorization for new client connections. SeeclientConnectOptionsBlock Reference below for details.clientLoginBannerOptionsOptions for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. SeeclientLoginBannerOptionsBlock Reference below for details.clientRouteEnforcementOptionsOptions for enforce administrator defined routes on devices connected through the VPN. SeeclientRouteEnforcementOptionsBlock Reference below for details.connectionLogOptionsInformation about the client connection logging options. SeeconnectionLogOptionsBlock Reference below for details.descriptionA brief description of the Client VPN endpoint.disconnectOnSessionTimeoutIndicates whether the client VPN session is disconnected after the maximumsessionTimeoutHoursis reached. Iftrue, users are prompted to reconnect client VPN. Iffalse, client VPN attempts to reconnect automatically. The default value isfalse.dnsNameThe DNS name to be used by clients when establishing their VPN session.dnsServersInformation 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.endpointIpAddressTypeIP address type for the Client VPN endpoint. Valid values areipv4,ipv6, ordual-stack. Defaults toipv4.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.securityGroupIdsThe 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 withtransitGatewayConfiguration.selfServicePortalSpecify whether to enable the self-service portal for the Client VPN endpoint. Values can beenabledordisabled. Default value isdisabled.selfServicePortalUrlThe URL of the self-service portal.serverCertificateArnThe ARN of the ACM server certificate.sessionTimeoutHoursThe maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is24- Valid values:8 | 10 | 12 | 24splitTunnelIndicates whether split-tunnel is enabled on VPN endpoint. Default value isfalse.tagsA mapping of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.trafficIpAddressTypeIP address type for traffic within the Client VPN tunnel. Valid values areipv4,ipv6, ordual-stack. Defaults toipv4. When it is set toipv6,clientCidrBlockmust not be specified.transitGatewayConfigurationConfiguration block for associating the Client VPN endpoint with a Transit Gateway. Conflicts withvpcIdandsecurityGroupIds. SeetransitGatewayConfigurationBlock Reference below for details.transportProtocolThe transport protocol to be used by the VPN session. Default value isudp.vpcIdThe 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 withtransitGatewayConfiguration.vpnPortThe port number for the Client VPN endpoint. Valid values are443and1194. Default value is443.const -
EndpointState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
The ARN of the Client VPN endpoint.
final
-
authenticationOptions
→ Input<
List< ?EndpointAuthenticationOption> ?> -
Information about the authentication method to be used to authenticate clients. See
authenticationOptionsBlock 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
trafficIpAddressTypeis set toipv6, it must not be specified. Otherwise, it is required.final -
clientConnectOptions
→ Input<
EndpointClientConnectOptions?> ? -
The options for managing connection authorization for new client connections. See
clientConnectOptionsBlock 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
clientLoginBannerOptionsBlock Reference below for details.final -
clientRouteEnforcementOptions
→ Input<
EndpointClientRouteEnforcementOptions?> ? -
Options for enforce administrator defined routes on devices connected through the VPN. See
clientRouteEnforcementOptionsBlock Reference below for details.final -
connectionLogOptions
→ Input<
EndpointConnectionLogOptions?> ? -
Information about the client connection logging options. See
connectionLogOptionsBlock 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
sessionTimeoutHoursis reached. Iftrue, users are prompted to reconnect client VPN. Iffalse, client VPN attempts to reconnect automatically. The default value isfalse.final -
dnsName
→ Input<
String?> ? -
The DNS name to be used by clients when establishing their VPN session.
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, ordual-stack. Defaults toipv4.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
enabledordisabled. Default value isdisabled.final -
selfServicePortalUrl
→ Input<
String?> ? -
The URL of the self-service portal.
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 | 24final -
splitTunnel
→ Input<
bool?> ? -
Indicates whether split-tunnel is enabled on VPN endpoint. Default value is
false.final -
A mapping of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
trafficIpAddressType
→ Input<
String?> ? -
IP address type for traffic within the Client VPN tunnel. Valid values are
ipv4,ipv6, ordual-stack. Defaults toipv4. When it is set toipv6,clientCidrBlockmust not be specified.final -
transitGatewayConfiguration
→ Input<
EndpointTransitGatewayConfiguration?> ? -
Configuration block for associating the Client VPN endpoint with a Transit Gateway. Conflicts with
vpcIdandsecurityGroupIds. SeetransitGatewayConfigurationBlock 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
443and1194. Default value is443.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