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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateClientVpnEndpointRequest data as a hash:

{
  client_cidr_block: "String", # required
  server_certificate_arn: "String", # required
  authentication_options: [ # required
    {
      type: "certificate-authentication", # accepts certificate-authentication, directory-service-authentication
      active_directory: {
        directory_id: "String",
      },
      mutual_authentication: {
        client_root_certificate_chain_arn: "String",
      },
    },
  ],
  connection_log_options: { # required
    enabled: false,
    cloudwatch_log_group: "String",
    cloudwatch_log_stream: "String",
  },
  dns_servers: ["String"],
  transport_protocol: "tcp", # accepts tcp, udp
  description: "String",
  dry_run: false,
  client_token: "String",
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, image, instance, internet-gateway, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_options ⇒ Array<Types::ClientVpnAuthenticationRequest>

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

Returns:



4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  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. The CIDR block should be /22 or greater.

Returns:

  • (String) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier 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/UserGuide/Run_Instance_Idempotency.html

Returns:

  • (String) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

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



4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end

#description ⇒ String

A brief description of the Client VPN endpoint.

Returns:

  • (String) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  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 of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

Returns:

  • (Array<String>) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

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


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end

#server_certificate_arn ⇒ String

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

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

Returns:

  • (String) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

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

Returns:



4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end

#transport_protocol ⇒ String

The transport protocol to be used by the VPN session.

Default value: ‘udp`

Returns:

  • (String) 


4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/aws-sdk-ec2/types.rb', line 4194

class CreateClientVpnEndpointRequest < Struct.new(
  :client_cidr_block,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :dns_servers,
  :transport_protocol,
  :description,
  :dry_run,
  :client_token,
  :tag_specifications)
  include Aws::Structure
end