Class: Aws::EC2::Types::CreateClientVpnEndpointRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::CreateClientVpnEndpointRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#authentication_options ⇒ Array<Types::ClientVpnAuthenticationRequest>

Information about the authentication method to be used to authenticate clients.
#client_cidr_block ⇒ String

The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
#client_connect_options ⇒ Types::ClientConnectOptions

The options for managing connection authorization for new client connections.
#client_login_banner_options ⇒ Types::ClientLoginBannerOptions

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#connection_log_options ⇒ Types::ConnectionLogOptions

Information about the client connection logging options.
#description ⇒ String

A brief description of the Client VPN endpoint.
#dns_servers ⇒ Array<String>

Information about the DNS servers to be used for DNS resolution.
#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#security_group_ids ⇒ Array<String>

The IDs of one or more security groups to apply to the target network.
#self_service_portal ⇒ String

Specify whether to enable the self-service portal for the Client VPN endpoint.
#server_certificate_arn ⇒ String

The 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 on the Client VPN endpoint.
#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the Client VPN endpoint during creation.
#transport_protocol ⇒ String

The transport protocol to be used by the VPN session.
#vpc_id ⇒ String

The ID of the VPC to associate with the Client VPN endpoint.
#vpn_port ⇒ Integer

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Instance Attribute Details

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

Information about the authentication method to be used to authenticate clients.

Returns:

(Array<Types::ClientVpnAuthenticationRequest>)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :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 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. Client CIDR range must have a size of at least /22 and must not be greater than /12.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_connect_options ⇒ `Types::ClientConnectOptions`

The options for managing connection authorization for new client connections.

Returns:

(Types::ClientConnectOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_login_banner_options ⇒ `Types::ClientLoginBannerOptions`

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::ClientLoginBannerOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#connection_log_options ⇒ `Types::ConnectionLogOptions`

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time

Returns:

(Types::ConnectionLogOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A brief description of the Client VPN endpoint.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#dns_servers ⇒ `Array<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 configured on the device is used for the DNS server.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#self_service_portal ⇒ `String`

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: ‘enabled`

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#server_certificate_arn ⇒ `String`

The ARN of the server certificate. For more information, see the [Certificate Manager User Guide].

[1]: docs.aws.amazon.com/acm/latest/userguide/

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :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.

Valid values: ‘8 | 10 | 12 | 24`

Default value: ‘24`

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#split_tunnel ⇒ `Boolean`

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

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see [Split-tunnel Client VPN endpoint] in the *Client VPN Administrator Guide*.

[1]: docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The tags to apply to the Client VPN endpoint during creation.

Returns:

(Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#transport_protocol ⇒ `String`

The transport protocol to be used by the VPN session.

Default value: ‘udp`

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_port ⇒ `Integer`

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: ‘443` | `1194`

Default Value: ‘443`

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 7181

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :client_token,
  :tag_specifications,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::CreateClientVpnEndpointRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_options ⇒ Array<Types::ClientVpnAuthenticationRequest>

#client_cidr_block ⇒ String

#client_connect_options ⇒ Types::ClientConnectOptions

#client_login_banner_options ⇒ Types::ClientLoginBannerOptions

#client_token ⇒ String

#connection_log_options ⇒ Types::ConnectionLogOptions

#description ⇒ String

#dns_servers ⇒ Array<String>

#dry_run ⇒ Boolean

#security_group_ids ⇒ Array<String>

#self_service_portal ⇒ String

#server_certificate_arn ⇒ String

#session_timeout_hours ⇒ Integer

#split_tunnel ⇒ Boolean

#tag_specifications ⇒ Array<Types::TagSpecification>

#transport_protocol ⇒ String

#vpc_id ⇒ String

#vpn_port ⇒ Integer

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

#client_cidr_block ⇒ `String`

#client_connect_options ⇒ `Types::ClientConnectOptions`

#client_login_banner_options ⇒ `Types::ClientLoginBannerOptions`

#client_token ⇒ `String`

#connection_log_options ⇒ `Types::ConnectionLogOptions`

#description ⇒ `String`

#dns_servers ⇒ `Array<String>`

#dry_run ⇒ `Boolean`

#security_group_ids ⇒ `Array<String>`

#self_service_portal ⇒ `String`

#server_certificate_arn ⇒ `String`

#session_timeout_hours ⇒ `Integer`

#split_tunnel ⇒ `Boolean`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#transport_protocol ⇒ `String`

#vpc_id ⇒ `String`

#vpn_port ⇒ `Integer`