Class: Aws::SecurityHub::Types::AwsEc2ClientVpnEndpointDetails

Inherits:

Struct

Object
Struct
Aws::SecurityHub::Types::AwsEc2ClientVpnEndpointDetails

show all

Defined in:: gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Describes an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#authentication_options ⇒ Array<Types::AwsEc2ClientVpnEndpointAuthenticationOptionsDetails>
Information about the authentication method used by the Client VPN endpoint.
#client_cidr_block ⇒ String
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
#client_connect_options ⇒ Types::AwsEc2ClientVpnEndpointClientConnectOptionsDetails
The options for managing connection authorization for new client connections.
#client_login_banner_options ⇒ Types::AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
#client_vpn_endpoint_id ⇒ String
The ID of the Client VPN endpoint.
#connection_log_options ⇒ Types::AwsEc2ClientVpnEndpointConnectionLogOptionsDetails
Information about the client connection logging options for the Client VPN endpoint.
#description ⇒ String
A brief description of the endpoint.
#dns_server ⇒ Array<String>
Information about the DNS servers to be used for DNS resolution.
#security_group_id_set ⇒ Array<String>
The IDs of the security groups for the target network.
#self_service_portal_url ⇒ String
The URL of the self-service portal.
#server_certificate_arn ⇒ String
The Amazon Resource Name (ARN) of the server certificate.
#session_timeout_hours ⇒ Integer
The maximum VPN session duration time in hours.
#split_tunnel ⇒ Boolean
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
#transport_protocol ⇒ String
The transport protocol used by the Client VPN endpoint.
#vpc_id ⇒ String
The ID of the VPC.
#vpn_port ⇒ Integer
The port number for the Client VPN endpoint.

Instance Attribute Details

#authentication_options ⇒ `Array<Types::AwsEc2ClientVpnEndpointAuthenticationOptionsDetails>`

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

Returns:

(Array<Types::AwsEc2ClientVpnEndpointAuthenticationOptionsDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_cidr_block ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_connect_options ⇒ `Types::AwsEc2ClientVpnEndpointClientConnectOptionsDetails`

The options for managing connection authorization for new client connections.

Returns:

(Types::AwsEc2ClientVpnEndpointClientConnectOptionsDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_login_banner_options ⇒ `Types::AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails`

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

Returns:

(Types::AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_vpn_endpoint_id ⇒ `String`

The ID of the Client VPN endpoint.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#connection_log_options ⇒ `Types::AwsEc2ClientVpnEndpointConnectionLogOptionsDetails`

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

Returns:

(Types::AwsEc2ClientVpnEndpointConnectionLogOptionsDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A brief description of the endpoint.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#dns_server ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_id_set ⇒ `Array<String>`

The IDs of the security groups for the target network.

Returns:

(Array<String>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#self_service_portal_url ⇒ `String`

The URL of the self-service portal.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#server_certificate_arn ⇒ `String`

The Amazon Resource Name (ARN) of the server certificate.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#session_timeout_hours ⇒ `Integer`

The maximum VPN session duration time in hours.

Returns:

(Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#split_tunnel ⇒ `Boolean`

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

Returns:

(Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#transport_protocol ⇒ `String`

The transport protocol used by the Client VPN endpoint.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The ID of the VPC.

Returns:

(String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_port ⇒ `Integer`

The port number for the Client VPN endpoint.

Returns:

(Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6607

class AwsEc2ClientVpnEndpointDetails < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :client_cidr_block,
  :dns_server,
  :split_tunnel,
  :transport_protocol,
  :vpn_port,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :security_group_id_set,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SecurityHub::Types::AwsEc2ClientVpnEndpointDetails

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_options ⇒ Array<Types::AwsEc2ClientVpnEndpointAuthenticationOptionsDetails>

#client_cidr_block ⇒ String

#client_connect_options ⇒ Types::AwsEc2ClientVpnEndpointClientConnectOptionsDetails

#client_login_banner_options ⇒ Types::AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails

#client_vpn_endpoint_id ⇒ String

#connection_log_options ⇒ Types::AwsEc2ClientVpnEndpointConnectionLogOptionsDetails

#description ⇒ String

#dns_server ⇒ Array<String>

#security_group_id_set ⇒ Array<String>

#self_service_portal_url ⇒ String

#server_certificate_arn ⇒ String

#session_timeout_hours ⇒ Integer

#split_tunnel ⇒ Boolean

#transport_protocol ⇒ String

#vpc_id ⇒ String

#vpn_port ⇒ Integer

#authentication_options ⇒ `Array<Types::AwsEc2ClientVpnEndpointAuthenticationOptionsDetails>`

#client_cidr_block ⇒ `String`

#client_connect_options ⇒ `Types::AwsEc2ClientVpnEndpointClientConnectOptionsDetails`

#client_login_banner_options ⇒ `Types::AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails`

#client_vpn_endpoint_id ⇒ `String`

#connection_log_options ⇒ `Types::AwsEc2ClientVpnEndpointConnectionLogOptionsDetails`

#description ⇒ `String`

#dns_server ⇒ `Array<String>`

#security_group_id_set ⇒ `Array<String>`

#self_service_portal_url ⇒ `String`

#server_certificate_arn ⇒ `String`

#session_timeout_hours ⇒ `Integer`

#split_tunnel ⇒ `Boolean`

#transport_protocol ⇒ `String`

#vpc_id ⇒ `String`

#vpn_port ⇒ `Integer`